https://www.stridewiki.com/api.php?action=feedcontributions&feedformat=atom&user=Chrisj 2026-04-29T08:37:59Z User contributions MediaWiki 1.39.10 https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8230 2008-11-04T01:20:45Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> * If the last member of the structure is an array, the array's element type may not contain a sized structure or a conformant array (see [[scl_conform]]).<br /> <br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8229 2008-11-04T01:20:04Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> * If the last member of the structure is an array, the array's element type may not contain a sized structure or a conformant array (see scl_conform).<br /> <br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8228 2008-11-04T01:19:24Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> * If the last member of the structure is an array, the array's element type may not contain a sized structure (scl_struct_sized) or a conformant array (scl_conform).<br /> <br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8213 2008-11-01T00:12:15Z

<p>Chrisj: /* Example 2 */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8212 2008-11-01T00:12:00Z

<p>Chrisj: /* Example 1 */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_function(f)<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8211 2008-11-01T00:11:29Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct,&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:SCL_Pragmas&diff=8210 2008-11-01T00:08:36Z

<p>Chrisj: /* Qualification */</p> <hr /> <div>== Introduction ==<br /> The SCL pragmas are designed to allow annotation of C language constructs in such a way as to identify and define messages, function calls, and trace points so that they can be transparently intercepted and remoted. Some pragmas are necessary because C language constructs lack important interface details; other pragmas are necessary because they allow STRIDE to better represent information to the user, or allow STRIDE to take advantage of increased opportunities for efficiency. Lastly, some pragmas simply make it easier for users to adopt STRIDE without changing existing source code.<br /> <br /> Pragmas are used to elaborate all of the following areas: <br /> * The set of messages and functions within the application that are candidates for interception and remoting. <br /> * Use of pointers. Pointer-related ambiguities include memory ownership, data directions, and pointers that point to a sequence of elements rather than to a single element. <br /> * The convention of using null-terminated strings in C. When a pointer is declared as ”char *”, it must be further elaborated as pointing to a single character or a series of characters ending in NULL. <br /> * Pointers to functions. Functions whose addresses are passed as parameters must be identified. <br /> * Pointers to data which should be treated by STRIDE as ”void*” rather than its declared type. This may be necessary because of self-referential data structures or efficiency concerns. <br /> * Unions. The discriminant (if any) must be identified; the relationship between active union members and discriminant values must be prescribed. <br /> * Convenience pragmas to constrain the allowable values of a data item.<br /> * Convenience pragmas to allow STRIDE to treat a data item as if it was defined to be of another type. <br /> * Pragmas to allow STRIDE to identify certain structures, such as v-tables, used in C programs to simulate C++ inheritance and virtual function mechanisms. <br /> * The STRIDE-defined constructs known as trace points. <br /> * The special constructs known as conformant arrays (also known as variable length arrays). <br /> <br /> The SCL Wizard streamlines and simplifies working with pragmas by allowing you to quickly capture interfaces and accurately qualify payloads and types. See the Online Help installed with STRIDE for more information on the SCL Wizard.<br /> <br /> == Remotable Interfaces ==<br /> SCL includes pragmas used to identify remotable messages or functions. Only messages or functions identified with these pragmas are remotable candidates. These remotable candidates are also referred to as interfaces. Almost all other pragmas operate on, or depend upon, the set of interfaces identified as remotable. <br /> <br /> By far, the most important aspect of a remotable interface is the memory layout of the data that is passed from message sender or function caller. Most pragmas allow the data format to be described in detail. Throughout the STRIDE documentation, the data exchanged for a given instance of a message or function is referred to as the '''payload'''. <br /> <br /> Since STRIDE represents communication via both messaging and function calls, the terms '''user''' and '''owner''' are used to identify the sender/receiver of a message or the caller/callee of a function, respectively. Within a message, the user is the agent sending the message and owner is the agent that receives the message. Within a function call, the user is the caller and the owner is the callee. <br /> <br /> === Payloads ===<br /> The data passed between user and owner is referred to as a payload. Not all messages or functions contain a payload. Consider the function <br /> &lt;source lang=c&gt;<br /> void f(void); <br /> &lt;/source&gt;<br /> <br /> This function has no return value and no parameters; thus it has no payload. <br /> <br /> ==== Message Payloads ====<br /> Message payloads are defined by a C datatype. For example, we may have message ERROR that has an associated structure containing the error code and a string. The relevant C language declarations might be: <br /> &lt;source lang=c&gt;<br /> #define ERROR_MSG 23 // the message id for ERRROR<br /> <br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> &lt;/source&gt;<br /> <br /> Messages payloads are typically passed by reference (but can also be passed by value). Assuming the message payload above is passed by reference we can depict the memory layout of the entire message payload as follows:<br /> <br /> [[Image:message_payload.gif|center]]<br /> <br /> <br /> Note that in this instance, the payload actually consists of two distinct memory blocks &amp;endash; a pointer and the structure pointed to. The distinct blocks in a payload are referred to as the payload blocks. Note also that the blocks form a tree structure, with each contiguous memory block representing a node in the tree. This illustrates a more general concept: the payload blocks form a network, and that network must be a tree (i.e., it starts with a node designated as the root, and all other nodes are reachable from the root. There cannot be cycles).<br /> <br /> Within a two-way message, the structure of data passed in each direction may be different. For this reason, payloads must be further defined according to whether they are passed from user to owner or owner to user. Payloads passed from user to owner are called Command Payloads. Payloads passed from owner to user are called Response Payloads.<br /> <br /> ==== Function Payloads ====<br /> Functions are much like two-way messages in that data can be passed from user (caller) to the owner (callee) at the time of the call, and the owner (callee) may pass data back to the user (caller) at the time of the return. As with message payloads, the data passed from user to owner is referred to as the Command Payload and the data passed from owner to user is referred to as the Response Payload. <br /> <br /> A Command Payload is constructed from the formal parameters of a function, and is a synthesized C structure. The members of the structure correspond to the formal parameters of the function (both the order and types of the members correspond exactly). <br /> <br /> The Response Payload for a function is constructed from the return value of a function. Below is an example of the Command and Response Payload memory layout for a simple function Error(): <br /> &lt;source lang=c&gt;<br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> <br /> int Error(ErrorMessagePayload *pPayload, BOOL bPopupMessage); <br /> &lt;/source&gt;<br /> <br /> [[Image:command_payload.gif|center]]<br /> <br /> == Pragmas ==<br /> <br /> The SCL pragmas are listed here, categorized by function:<br /> <br /> === Test Units ===<br /> <br /> * [[scl_test_class]]<br /> * [[scl_test_cclass]]<br /> * [[scl_test_flist]]<br /> * [[scl_test_setup]]<br /> * [[scl_test_teardown]]<br /> <br /> === Capture ===<br /> <br /> * [[scl_func]]<br /> * [[scl_function]]<br /> * [[scl_msg]]<br /> * [[scl_msg_bind]]<br /> <br /> === Qualification ===<br /> <br /> * [[scl_brew_class]]<br /> * [[scl_cast]]<br /> * [[scl_conform]]<br /> * [[scl_ptr]]<br /> * [[scl_ptr_flist]]<br /> * [[scl_ptr_opaque]]<br /> * [[scl_ptr_sized]]<br /> * [[scl_string]]<br /> * [[scl_struct_sized]] ''(coming soon)''<br /> * [[scl_union]]<br /> * [[scl_union_activate]]<br /> * [[scl_values]]<br /> <br /> === Trace ===<br /> <br /> * [[scl_tracepoint]]<br /> * [[scl_tracepoint_format]]<br /> <br /> == Notes ==<br /> <br /> * The hash (#) symbol that begins the pragma directive must be the first non-white-space character on the line containing the pragma, e.g. #pragma.<br /> * Compilers typically issue warnings, but not errors, for unrecognized pragmas. An SCL-compliant compiler is required to automatically define the _SCL symbol. It is recommended that a header file using SCL pragmas include the following conditional compile statement wrapped around the pragma definitions:<br /> &lt;source lang=c&gt;<br /> #ifdef _SCL<br /> <br /> //... pragma definitions<br /> <br /> #endif // #ifdef _SCL<br /> &lt;/source&gt;<br /> <br /> * The use of packed pragmas may result in structure alignment issues when communicating with the target platform.<br /> <br /> * STRIDE pragmas should be added to header (.h) files. Although such pragmas could be added to implementation (.c/cpp) files it is not recommended because it may lead to linkage problems when integrating the generated IM code in to your application.<br /> <br /> == See Also ==<br /> *[[SCL Structure]]<br /> *[[SCL Data Types]]<br /> *[[SCL Design Requirements]]<br /> *[[SCL Message Attributes]]<br /> *For detailed instructions on working with SCL, including code samples and examples, refer to the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> *Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.<br /> <br /> [[Category: SCL]]<br /> [[Category: Reference]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:SCL_Pragmas&diff=8209 2008-11-01T00:08:14Z

<p>Chrisj: /* Qualification */</p> <hr /> <div>== Introduction ==<br /> The SCL pragmas are designed to allow annotation of C language constructs in such a way as to identify and define messages, function calls, and trace points so that they can be transparently intercepted and remoted. Some pragmas are necessary because C language constructs lack important interface details; other pragmas are necessary because they allow STRIDE to better represent information to the user, or allow STRIDE to take advantage of increased opportunities for efficiency. Lastly, some pragmas simply make it easier for users to adopt STRIDE without changing existing source code.<br /> <br /> Pragmas are used to elaborate all of the following areas: <br /> * The set of messages and functions within the application that are candidates for interception and remoting. <br /> * Use of pointers. Pointer-related ambiguities include memory ownership, data directions, and pointers that point to a sequence of elements rather than to a single element. <br /> * The convention of using null-terminated strings in C. When a pointer is declared as ”char *”, it must be further elaborated as pointing to a single character or a series of characters ending in NULL. <br /> * Pointers to functions. Functions whose addresses are passed as parameters must be identified. <br /> * Pointers to data which should be treated by STRIDE as ”void*” rather than its declared type. This may be necessary because of self-referential data structures or efficiency concerns. <br /> * Unions. The discriminant (if any) must be identified; the relationship between active union members and discriminant values must be prescribed. <br /> * Convenience pragmas to constrain the allowable values of a data item.<br /> * Convenience pragmas to allow STRIDE to treat a data item as if it was defined to be of another type. <br /> * Pragmas to allow STRIDE to identify certain structures, such as v-tables, used in C programs to simulate C++ inheritance and virtual function mechanisms. <br /> * The STRIDE-defined constructs known as trace points. <br /> * The special constructs known as conformant arrays (also known as variable length arrays). <br /> <br /> The SCL Wizard streamlines and simplifies working with pragmas by allowing you to quickly capture interfaces and accurately qualify payloads and types. See the Online Help installed with STRIDE for more information on the SCL Wizard.<br /> <br /> == Remotable Interfaces ==<br /> SCL includes pragmas used to identify remotable messages or functions. Only messages or functions identified with these pragmas are remotable candidates. These remotable candidates are also referred to as interfaces. Almost all other pragmas operate on, or depend upon, the set of interfaces identified as remotable. <br /> <br /> By far, the most important aspect of a remotable interface is the memory layout of the data that is passed from message sender or function caller. Most pragmas allow the data format to be described in detail. Throughout the STRIDE documentation, the data exchanged for a given instance of a message or function is referred to as the '''payload'''. <br /> <br /> Since STRIDE represents communication via both messaging and function calls, the terms '''user''' and '''owner''' are used to identify the sender/receiver of a message or the caller/callee of a function, respectively. Within a message, the user is the agent sending the message and owner is the agent that receives the message. Within a function call, the user is the caller and the owner is the callee. <br /> <br /> === Payloads ===<br /> The data passed between user and owner is referred to as a payload. Not all messages or functions contain a payload. Consider the function <br /> &lt;source lang=c&gt;<br /> void f(void); <br /> &lt;/source&gt;<br /> <br /> This function has no return value and no parameters; thus it has no payload. <br /> <br /> ==== Message Payloads ====<br /> Message payloads are defined by a C datatype. For example, we may have message ERROR that has an associated structure containing the error code and a string. The relevant C language declarations might be: <br /> &lt;source lang=c&gt;<br /> #define ERROR_MSG 23 // the message id for ERRROR<br /> <br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> &lt;/source&gt;<br /> <br /> Messages payloads are typically passed by reference (but can also be passed by value). Assuming the message payload above is passed by reference we can depict the memory layout of the entire message payload as follows:<br /> <br /> [[Image:message_payload.gif|center]]<br /> <br /> <br /> Note that in this instance, the payload actually consists of two distinct memory blocks &amp;endash; a pointer and the structure pointed to. The distinct blocks in a payload are referred to as the payload blocks. Note also that the blocks form a tree structure, with each contiguous memory block representing a node in the tree. This illustrates a more general concept: the payload blocks form a network, and that network must be a tree (i.e., it starts with a node designated as the root, and all other nodes are reachable from the root. There cannot be cycles).<br /> <br /> Within a two-way message, the structure of data passed in each direction may be different. For this reason, payloads must be further defined according to whether they are passed from user to owner or owner to user. Payloads passed from user to owner are called Command Payloads. Payloads passed from owner to user are called Response Payloads.<br /> <br /> ==== Function Payloads ====<br /> Functions are much like two-way messages in that data can be passed from user (caller) to the owner (callee) at the time of the call, and the owner (callee) may pass data back to the user (caller) at the time of the return. As with message payloads, the data passed from user to owner is referred to as the Command Payload and the data passed from owner to user is referred to as the Response Payload. <br /> <br /> A Command Payload is constructed from the formal parameters of a function, and is a synthesized C structure. The members of the structure correspond to the formal parameters of the function (both the order and types of the members correspond exactly). <br /> <br /> The Response Payload for a function is constructed from the return value of a function. Below is an example of the Command and Response Payload memory layout for a simple function Error(): <br /> &lt;source lang=c&gt;<br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> <br /> int Error(ErrorMessagePayload *pPayload, BOOL bPopupMessage); <br /> &lt;/source&gt;<br /> <br /> [[Image:command_payload.gif|center]]<br /> <br /> == Pragmas ==<br /> <br /> The SCL pragmas are listed here, categorized by function:<br /> <br /> === Test Units ===<br /> <br /> * [[scl_test_class]]<br /> * [[scl_test_cclass]]<br /> * [[scl_test_flist]]<br /> * [[scl_test_setup]]<br /> * [[scl_test_teardown]]<br /> <br /> === Capture ===<br /> <br /> * [[scl_func]]<br /> * [[scl_function]]<br /> * [[scl_msg]]<br /> * [[scl_msg_bind]]<br /> <br /> === Qualification ===<br /> <br /> * [[scl_brew_class]]<br /> * [[scl_cast]]<br /> * [[scl_conform]]<br /> * [[scl_ptr]]<br /> * [[scl_ptr_flist]]<br /> * [[scl_ptr_opaque]]<br /> * [[scl_ptr_sized]] ''(coming soon)''<br /> * [[scl_string]]<br /> * [[scl_struct_sized]]<br /> * [[scl_union]]<br /> * [[scl_union_activate]]<br /> * [[scl_values]]<br /> <br /> === Trace ===<br /> <br /> * [[scl_tracepoint]]<br /> * [[scl_tracepoint_format]]<br /> <br /> == Notes ==<br /> <br /> * The hash (#) symbol that begins the pragma directive must be the first non-white-space character on the line containing the pragma, e.g. #pragma.<br /> * Compilers typically issue warnings, but not errors, for unrecognized pragmas. An SCL-compliant compiler is required to automatically define the _SCL symbol. It is recommended that a header file using SCL pragmas include the following conditional compile statement wrapped around the pragma definitions:<br /> &lt;source lang=c&gt;<br /> #ifdef _SCL<br /> <br /> //... pragma definitions<br /> <br /> #endif // #ifdef _SCL<br /> &lt;/source&gt;<br /> <br /> * The use of packed pragmas may result in structure alignment issues when communicating with the target platform.<br /> <br /> * STRIDE pragmas should be added to header (.h) files. Although such pragmas could be added to implementation (.c/cpp) files it is not recommended because it may lead to linkage problems when integrating the generated IM code in to your application.<br /> <br /> == See Also ==<br /> *[[SCL Structure]]<br /> *[[SCL Data Types]]<br /> *[[SCL Design Requirements]]<br /> *[[SCL Message Attributes]]<br /> *For detailed instructions on working with SCL, including code samples and examples, refer to the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> *Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.<br /> <br /> [[Category: SCL]]<br /> [[Category: Reference]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8208 2008-10-31T23:45:49Z

<p>Chrisj: /* The scl_struct_sized pragma */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:SCL_Pragmas&diff=8207 2008-10-31T23:45:13Z

<p>Chrisj: /* Qualification */</p> <hr /> <div>== Introduction ==<br /> The SCL pragmas are designed to allow annotation of C language constructs in such a way as to identify and define messages, function calls, and trace points so that they can be transparently intercepted and remoted. Some pragmas are necessary because C language constructs lack important interface details; other pragmas are necessary because they allow STRIDE to better represent information to the user, or allow STRIDE to take advantage of increased opportunities for efficiency. Lastly, some pragmas simply make it easier for users to adopt STRIDE without changing existing source code.<br /> <br /> Pragmas are used to elaborate all of the following areas: <br /> * The set of messages and functions within the application that are candidates for interception and remoting. <br /> * Use of pointers. Pointer-related ambiguities include memory ownership, data directions, and pointers that point to a sequence of elements rather than to a single element. <br /> * The convention of using null-terminated strings in C. When a pointer is declared as ”char *”, it must be further elaborated as pointing to a single character or a series of characters ending in NULL. <br /> * Pointers to functions. Functions whose addresses are passed as parameters must be identified. <br /> * Pointers to data which should be treated by STRIDE as ”void*” rather than its declared type. This may be necessary because of self-referential data structures or efficiency concerns. <br /> * Unions. The discriminant (if any) must be identified; the relationship between active union members and discriminant values must be prescribed. <br /> * Convenience pragmas to constrain the allowable values of a data item.<br /> * Convenience pragmas to allow STRIDE to treat a data item as if it was defined to be of another type. <br /> * Pragmas to allow STRIDE to identify certain structures, such as v-tables, used in C programs to simulate C++ inheritance and virtual function mechanisms. <br /> * The STRIDE-defined constructs known as trace points. <br /> * The special constructs known as conformant arrays (also known as variable length arrays). <br /> <br /> The SCL Wizard streamlines and simplifies working with pragmas by allowing you to quickly capture interfaces and accurately qualify payloads and types. See the Online Help installed with STRIDE for more information on the SCL Wizard.<br /> <br /> == Remotable Interfaces ==<br /> SCL includes pragmas used to identify remotable messages or functions. Only messages or functions identified with these pragmas are remotable candidates. These remotable candidates are also referred to as interfaces. Almost all other pragmas operate on, or depend upon, the set of interfaces identified as remotable. <br /> <br /> By far, the most important aspect of a remotable interface is the memory layout of the data that is passed from message sender or function caller. Most pragmas allow the data format to be described in detail. Throughout the STRIDE documentation, the data exchanged for a given instance of a message or function is referred to as the '''payload'''. <br /> <br /> Since STRIDE represents communication via both messaging and function calls, the terms '''user''' and '''owner''' are used to identify the sender/receiver of a message or the caller/callee of a function, respectively. Within a message, the user is the agent sending the message and owner is the agent that receives the message. Within a function call, the user is the caller and the owner is the callee. <br /> <br /> === Payloads ===<br /> The data passed between user and owner is referred to as a payload. Not all messages or functions contain a payload. Consider the function <br /> &lt;source lang=c&gt;<br /> void f(void); <br /> &lt;/source&gt;<br /> <br /> This function has no return value and no parameters; thus it has no payload. <br /> <br /> ==== Message Payloads ====<br /> Message payloads are defined by a C datatype. For example, we may have message ERROR that has an associated structure containing the error code and a string. The relevant C language declarations might be: <br /> &lt;source lang=c&gt;<br /> #define ERROR_MSG 23 // the message id for ERRROR<br /> <br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> &lt;/source&gt;<br /> <br /> Messages payloads are typically passed by reference (but can also be passed by value). Assuming the message payload above is passed by reference we can depict the memory layout of the entire message payload as follows:<br /> <br /> [[Image:message_payload.gif|center]]<br /> <br /> <br /> Note that in this instance, the payload actually consists of two distinct memory blocks &amp;endash; a pointer and the structure pointed to. The distinct blocks in a payload are referred to as the payload blocks. Note also that the blocks form a tree structure, with each contiguous memory block representing a node in the tree. This illustrates a more general concept: the payload blocks form a network, and that network must be a tree (i.e., it starts with a node designated as the root, and all other nodes are reachable from the root. There cannot be cycles).<br /> <br /> Within a two-way message, the structure of data passed in each direction may be different. For this reason, payloads must be further defined according to whether they are passed from user to owner or owner to user. Payloads passed from user to owner are called Command Payloads. Payloads passed from owner to user are called Response Payloads.<br /> <br /> ==== Function Payloads ====<br /> Functions are much like two-way messages in that data can be passed from user (caller) to the owner (callee) at the time of the call, and the owner (callee) may pass data back to the user (caller) at the time of the return. As with message payloads, the data passed from user to owner is referred to as the Command Payload and the data passed from owner to user is referred to as the Response Payload. <br /> <br /> A Command Payload is constructed from the formal parameters of a function, and is a synthesized C structure. The members of the structure correspond to the formal parameters of the function (both the order and types of the members correspond exactly). <br /> <br /> The Response Payload for a function is constructed from the return value of a function. Below is an example of the Command and Response Payload memory layout for a simple function Error(): <br /> &lt;source lang=c&gt;<br /> // The structure for the message data.<br /> typedef struct _ErrorMessagePayload {<br /> int errorCode; <br /> char[100] text;<br /> } ErrorMessagePayload; <br /> <br /> int Error(ErrorMessagePayload *pPayload, BOOL bPopupMessage); <br /> &lt;/source&gt;<br /> <br /> [[Image:command_payload.gif|center]]<br /> <br /> == Pragmas ==<br /> <br /> The SCL pragmas are listed here, categorized by function:<br /> <br /> === Test Units ===<br /> <br /> * [[scl_test_class]]<br /> * [[scl_test_cclass]]<br /> * [[scl_test_flist]]<br /> * [[scl_test_setup]]<br /> * [[scl_test_teardown]]<br /> <br /> === Capture ===<br /> <br /> * [[scl_func]]<br /> * [[scl_function]]<br /> * [[scl_msg]]<br /> * [[scl_msg_bind]]<br /> <br /> === Qualification ===<br /> <br /> * [[scl_brew_class]]<br /> * [[scl_cast]]<br /> * [[scl_conform]]<br /> * [[scl_ptr]]<br /> * [[scl_ptr_flist]]<br /> * [[scl_ptr_opaque]]<br /> * [[scl_ptr_sized]]<br /> * [[scl_string]]<br /> * [[scl_struct_sized]]<br /> * [[scl_union]]<br /> * [[scl_union_activate]]<br /> * [[scl_values]]<br /> <br /> === Trace ===<br /> <br /> * [[scl_tracepoint]]<br /> * [[scl_tracepoint_format]]<br /> <br /> == Notes ==<br /> <br /> * The hash (#) symbol that begins the pragma directive must be the first non-white-space character on the line containing the pragma, e.g. #pragma.<br /> * Compilers typically issue warnings, but not errors, for unrecognized pragmas. An SCL-compliant compiler is required to automatically define the _SCL symbol. It is recommended that a header file using SCL pragmas include the following conditional compile statement wrapped around the pragma definitions:<br /> &lt;source lang=c&gt;<br /> #ifdef _SCL<br /> <br /> //... pragma definitions<br /> <br /> #endif // #ifdef _SCL<br /> &lt;/source&gt;<br /> <br /> * The use of packed pragmas may result in structure alignment issues when communicating with the target platform.<br /> <br /> * STRIDE pragmas should be added to header (.h) files. Although such pragmas could be added to implementation (.c/cpp) files it is not recommended because it may lead to linkage problems when integrating the generated IM code in to your application.<br /> <br /> == See Also ==<br /> *[[SCL Structure]]<br /> *[[SCL Data Types]]<br /> *[[SCL Design Requirements]]<br /> *[[SCL Message Attributes]]<br /> *For detailed instructions on working with SCL, including code samples and examples, refer to the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> *Refer to the '''SCL Wizard''' section of the STRIDE Online Help for information on how to create SCL pragmas.<br /> <br /> [[Category: SCL]]<br /> [[Category: Reference]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8206 2008-10-31T23:43:34Z

<p>Chrisj: </p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_test_cclass pragma is one of the [[SCL_Pragmas#Qualification|Qualification]] pragmas. The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8205 2008-10-31T23:41:31Z

<p>Chrisj: /* Example 2 */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 1<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8204 2008-10-31T23:41:10Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Pointer<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8203 2008-10-31T23:39:49Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Struct*<br /> | Specifies a structure type (or a pointer to such type) that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8202 2008-10-31T23:39:20Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8201 2008-10-31T23:38:41Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;100&quot; | '''Parameters'''<br /> | width=&quot;100&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Field &lt;br&gt;(of type-name)<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8200 2008-10-31T23:38:09Z

<p>Chrisj: </p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | width=&quot;180&quot; | '''Parameters'''<br /> | width=&quot;60&quot; | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Field &lt;br&gt;(of type-name)<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8199 2008-10-31T23:37:15Z

<p>Chrisj: </p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; width=&quot;50&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or&lt;br&gt;Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Field &lt;br&gt;(of type-name)<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8198 2008-10-31T23:35:20Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct&lt;br&gt;Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> The following restrictions apply:<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Member Field of&lt;br&gt;type-name<br /> | Specifies the number of bytes to be allocated for the sized struct.<br /> The following restrictions apply:<br /> * The max-size type must be an integral type (int, short, char).<br /> * The max-size value (at runtime) may not be less than the structure's type size.<br /> * The max-size value (at runtime) may not exceed the maximum payload size.<br /> * The max_size field must be in the same payload block as the type-name sized struct (i.e. no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8190 2008-10-31T18:49:19Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Member Field of type-name<br /> | Specifies the number of bytes for the sized struct.<br /> * The value contained by max_size may not be less than the structure's type size.<br /> * The max-size value must be an integral type (int, short, char).<br /> * The max-size may not exceed the maximum payload size.<br /> * The max_size must reside in the same payload block as the sized struct (no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8189 2008-10-31T00:55:56Z

<p>Chrisj: /* Examples */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes for the sized struct.<br /> * The value contained by max_size may not be less than the structure's type size.<br /> * The max-size value must be an integral type (int, short, char).<br /> * The max-size may not exceed the maximum payload size.<br /> * The max_size must reside in the same payload block as the sized struct (no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct with a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8188 2008-10-31T00:51:05Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or Struct*<br /> | Specifies a structure type that is to be sized (allocated bytes beyond its type definition).<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes for the sized struct.<br /> * The value contained by max_size may not be less than the structure's type size.<br /> * The max-size value must be an integral type (int, short, char).<br /> * The max-size may not exceed the maximum payload size.<br /> * The max_size must reside in the same payload block as the sized struct (no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct s);<br /> #pragma scl_struct_sized(SimpleSizedStruct, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration for a simple sized struct using a pointer.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct containing a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8187 2008-10-31T00:50:11Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Struct or Struct*<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes for the sized struct.<br /> * The value contained by max_size may not be less than the structure's type size.<br /> * The max-size value must be an integral type (int, short, char).<br /> * The max-size may not exceed the maximum payload size.<br /> * The max_size must reside in the same payload block as the sized struct (no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct s);<br /> #pragma scl_struct_sized(SimpleSizedStruct, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration for a simple sized struct using a pointer.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct containing a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8186 2008-10-31T00:49:40Z

<p>Chrisj: /* Syntax */</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Type<br /> | Pointer-to-Struct or Struct&lt;br&gt;<br /> * The structure type may not be pointed to by a sized pointer.<br /> * The structure type may not be a member of any other structure or union.<br /> * The structure type may not be passed as a function parameter.<br /> * The structure type may only reside in IN/INOUT memory blocks.<br /> * If the last member of the structure is an array, the array's size is calculated based upon max-size - (size of struct's other members).<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes for the sized struct.<br /> * The value contained by max_size may not be less than the structure's type size.<br /> * The max-size value must be an integral type (int, short, char).<br /> * The max-size may not exceed the maximum payload size.<br /> * The max_size must reside in the same payload block as the sized struct (no indirection '*' or '-&gt;').<br /> |}<br /> <br /> == Examples ==<br /> <br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct s);<br /> #pragma scl_struct_sized(SimpleSizedStruct, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration for a simple sized struct using a pointer.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct containing a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=Studio:Scl_struct_sized&diff=8185 2008-10-31T00:30:11Z

<p>Chrisj: New page: = The scl_struct_sized pragma = The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past ...</p> <hr /> <div>= The scl_struct_sized pragma =<br /> <br /> The scl_struct_sized pragma identifies a particular struct or pointer-to-struct as a sized structure. A sized structure typically has bytes allocated past its type definition.<br /> <br /> == Syntax ==<br /> #pragma scl_struct_sized(type-name, max-size)<br /> <br /> {| border=&quot;1&quot; cellspacing=&quot;0&quot; cellpadding=&quot;10&quot; style=&quot;align:left;&quot; <br /> | '''Parameters'''<br /> | '''Type'''<br /> | '''Description'''<br /> |-<br /> | ''type-name''<br /> | Type<br /> | Name of the type that contains the struct/pointer:&lt;br&gt;<br /> * structure&lt;br&gt;<br /> * pointer type&lt;br&gt;<br /> * function name&lt;br&gt;<br /> |-<br /> | ''max-size''<br /> | Integer<br /> | Specifies the number of bytes for the sized struct.<br /> |}<br /> <br /> == Examples ==<br /> <br /> <br /> === Example 1 ===<br /> This example shows the declaration for a simple sized struct.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct s);<br /> #pragma scl_struct_sized(SimpleSizedStruct, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration for a simple sized struct using a pointer.<br /> &lt;source lang=c&gt;<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int nMoreJunk;<br /> } SimpleSizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> === Example 2 ===<br /> This example shows the declaration of a sized struct containing a conformant array.<br /> &lt;source lang=c&gt;<br /> #define SOME_BOUND 0<br /> typedef struct {<br /> int nSize;<br /> int nSomeJunk;<br /> int ary[SOME_BOUND];<br /> } ConformantArraySizedStruct;<br /> <br /> extern void f(SimpleSizedStruct* s);<br /> #pragma scl_struct_sized(f.s, nSize);<br /> <br /> &lt;/source&gt;<br /> <br /> == See Also ==<br /> * For additional information on scl_string, including constraints, refer to the section on scl_struct_sized in the [[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]].<br /> <br /> [[Category: SCL]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8127 2008-10-16T00:06:01Z

<p>Chrisj: /* Windows Applications using Windows Off-Target SDK */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for [[AutoScript#ascript|''AutoScript'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. <br /> In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via <br /> keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will <br /> bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind <br /> for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run().&lt;br&gt;Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8126 2008-10-16T00:05:43Z

<p>Chrisj: /* Windows Applications using Windows Off-Target SDK */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for [[AutoScript#ascript|''AutoScript'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. <br /> In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via <br /> keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will <br /> bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind <br /> for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). <br /> Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8125 2008-10-16T00:04:50Z

<p>Chrisj: /* Windows Applications using Windows Off-Target SDK */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for [[AutoScript#ascript|''AutoScript'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. <br /> In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via <br /> keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will <br /> bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind <br /> for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8124 2008-10-16T00:00:16Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for [[AutoScript#ascript|''AutoScript'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8123 2008-10-15T23:59:29Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript (for details see [[AutoScript#ascript|''AutoScript API Reference'']]). <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8122 2008-10-15T23:58:52Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript (for details see the [[AutoScript#ascript|''AutoScript API Reference'']]). <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8121 2008-10-15T23:58:15Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. For details see the [[AutoScript#ascript|''AutoScript API Reference'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8120 2008-10-15T23:57:21Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [[AutoScript#ascript|''AutoScript API Reference'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8119 2008-10-15T23:55:16Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [[#AutoScript|''AutoScript API Reference'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8118 2008-10-15T23:53:53Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [[#ascript|''AutoScript API Reference'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8117 2008-10-15T23:53:19Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [#ascript|''AutoScript API Reference'']. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8116 2008-10-15T23:51:38Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [http://www.s2technologies.com/wiki/index.php?title=AutoScript|''AutoScript API Reference'']. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8115 2008-10-15T23:51:15Z

<p>Chrisj: /* API Changes */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the [[http://www.s2technologies.com/wiki/index.php?title=AutoScript|''AutoScript API Reference'']]. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8114 2008-10-15T23:46:28Z

<p>Chrisj: /* End-Of-Lifed Methods and Properties */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Life Methods and Properties ===<br /> <br /> This release marks the End-Of-Life (EOL) for the listed methods and properties. A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8113 2008-10-15T23:41:52Z

<p>Chrisj: /* AutoScript */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> &lt;br&gt; <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8112 2008-10-15T23:41:23Z

<p>Chrisj: /* AutoScript */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8111 2008-10-15T23:40:39Z

<p>Chrisj: /* Removed Modules */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. If a native <br /> operating system does not support dynamic memory, the Runtime's memory <br /> management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8110 2008-10-15T23:39:17Z

<p>Chrisj: /* Removed Modules */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - The memory module provided as part of PAL has been removed. <br /> If native OS does not support dynamic memory, <br /> Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8109 2008-10-15T23:35:20Z

<p>Chrisj: /* Change Details */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing API methods have been modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8108 2008-10-15T23:33:58Z

<p>Chrisj: /* Installing the Software */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note: if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8107 2008-10-15T23:31:17Z

<p>Chrisj: /* Multi-Process Targets */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include: implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8106 2008-10-15T23:30:25Z

<p>Chrisj: /* Multi-Process Targets */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process targets. Changes include implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs.<br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8105 2008-10-15T23:29:05Z

<p>Chrisj: /* Build Tools */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with a &quot;make&quot; build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process target. Changes include implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs. <br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8104 2008-10-15T23:28:28Z

<p>Chrisj: /* Build Tools */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with &quot;make&quot;-like build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process target. Changes include implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs. <br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj https://www.stridewiki.com/index.php?title=STRIDE_3.0.01xx&diff=8103 2008-10-15T23:27:53Z

<p>Chrisj: /* Build Tools */</p> <hr /> <div>'''Release Notes''' <br /> <br /> This page documents the changes in STRIDE version 3.0.01xx (code name ''StoneSteps''). <br /> <br /> Please review this information before upgrading from an earlier version. <br /> <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> &lt;br&gt; <br /> <br /> = What's New =<br /> <br /> Based on customer feedback, in this release we have made significant performance improvements as well as many key usability improvements and bug fixes. <br /> <br /> == Performance Improvements ==<br /> <br /> Specific improvements have been made in the following areas: <br /> <br /> *Database loading time has been improved <br /> *Compile times are now shorter <br /> *Scripting operations involving function and message payloads now perform better, especially when arrays are involved <br /> *Runtime performance has been improved by optimizing payload serialization and deserialization operations<br /> <br /> == Usability Improvements ==<br /> <br /> === SCL Wizard ===<br /> <br /> The SCL Wizard functionality in [[STRIDE Studio]] has been extended so that you can now use the tool to qualify message payloads as well as function payloads. <br /> <br /> In addition, the following types of qualifications can now be made: <br /> <br /> *For payloads that include function pointers, the SCL Wizard now supports qualifying the pointers as such and identifying candidate function values <br /> *Type casts can now be specified on payload members<br /> <br /> === Connection Management ===<br /> <br /> Connection management has been greatly simplified; software managing connection to the target system has been integrated into [[STRIDE Studio]] so that connections can be managed directly from there. (It is still possible to access connection management functionality without using Studio.) <br /> <br /> The Panel program is no longer used, and there is no longer a requirement to load the database to communicate with a remote target. <br /> <br /> ==== Transport Properties ====<br /> <br /> All transport properties can now be accessed via scripts. A new transport scripting model makes this possible.<br /> <br /> === STRIDE Studio Test Runner Improvements ===<br /> <br /> The test runner in [[STRIDE Studio]] has incorporated several functional and usability improvements. <br /> <br /> *Each runnable script and folder (Suite) in a workspace now has additional properties that allow you to optionally specify a handler script that will be executed in the case of an unhandled error (property OnError) or a timeout (property OnTimeout). A timeout value can be set for each folder.<br /> <br /> *Each runnable folder (Suite) in a workspace now has a property (OnRunConnect) that can instruct STRIDE Studio to automatically connect to a target system before the folder is executed.<br /> <br /> *The workspace now has a dynamic property (ExecutionState) that allows you to alter the order of script execution at runtime.<br /> <br /> === New Frameworks Feature ===<br /> <br /> This version introduces [[Using Frameworks|Target Frameworks]], which provide customizable templates for workspace creation. The use of frameworks simplifies the use of STRIDE and ensures consistency across a development team. <br /> <br /> Several [[Provided Frameworks|reference frameworks]] are included in this release, supporting the following target environments: <br /> <br /> *[[Provided Frameworks#Windows|Windows]] <br /> *[[Provided Frameworks#Linux|Linux]] <br /> *[[Provided Frameworks#WinMobile|WinMobile]] <br /> *[[Provided Frameworks#Generic|Generic]]<br /> <br /> [[Using Packages|Packages]] are also introduced. These provide a convenient way to encapsulate SCL-annotated source code and corresponding tests for a set of interfaces. <br /> <br /> === Uploading Results to STRIDE Portal ===<br /> <br /> Uploading test results from STRIDE Reporter to STRIDE Portal has been integrated into STRIDE Studio. Portal's server information can be configured from Studio's workspace properties while uploading results to Portal can be enabled or disabled via workspace context menu. If enabled, after running the workspace, a script folder or a script file, results in Report file will automatically be uploaded to the configured server. <br /> <br /> == Build Tools ==<br /> <br /> A set of new command line [[Build Tools]] has been implemented: <br /> <br /> *'''Stride compiler''' <br /> *'''Stride database binder''' <br /> *'''Stride instrumentation generator'''<br /> <br /> These utilities has been ported for Windows and Linux. Using them would allow seamless integration with &quot;make&quot; like build environment.<br /> <br /> == Target-Based Testing ==<br /> <br /> Target-based (xUnit-style) testing has been simplified. The new set of SCL pragmas [[Test Units]] can now be included in a source file to tell the compiler and IM generator to automatically create test harnessing code.<br /> <br /> The automation components STRIDE.testclass, STRIDE.testunit and STRIDE.testfunction are removed.<br /> <br /> == Runtime/PAL ==<br /> <br /> Based on customer requirements, in this release we have made significant changes to [[Target_Integration#The STRIDE Runtime|STRIDE Runtime]] and [[Target_Integration#The Platform Abstraction Layer (PAL)|PAL]]. <br /> <br /> === Multi-Process Targets ===<br /> <br /> New routines and support have been added to Runtime and PAL to support multi-process target. Changes include implementation of memory management and shared memory, protecting using named Mutex objects, synchronization of multiple processors and multiple threads, and usage of current process and thread IDs. <br /> <br /> === Logging (Optional) ===<br /> <br /> Runtime and PAL use a logging routine that can optionally be implemented in PAL. <br /> <br /> == Windows Off-Target SDK ==<br /> <br /> A new [[Windows_Off-Target_SDK|SDK]] for implemention of Off-Target applications on Windows has been packaged. It contains a library (s2srWin.dll/lib) in which the Windows PAL, Runtime, and GRS and a set of utility scripts are prebuilt. <br /> <br /> The '''s2shostapphrt''' library, a prebuilt verion of the Host Runtime, has been removed. Building Windows applications using the Host Runtime is not supported anymore. The '''s2shostapptrt''' library, a prebuilt version of the Target Runtime, has also been removed. <br /> <br /> If an upgrade is performed it is strongly recommended that the above mentioned '''s2shostapp*''' libraries and their public API header (hostapp.h) be manually removed.<br /> <br /> = Support Wiki =<br /> <br /> This support wiki http://support.s2technologies.com is introduced with this version. You can navigate here from your web browser, or directly from STRIDE Studio; a link is provided in the Help menu. <br /> <br /> == STRIDE Samples ==<br /> <br /> We have created a set of [[Samples_Overview|sample workspaces]] to aid in the evaluation of STRIDE, or as a tool for learning how to apply STRIDE to different testing scenarios. <br /> <br /> If you're new to STRIDE, or want to learn more about using the product, this is a great place to start.<br /> <br /> = Acquiring the Software =<br /> <br /> You can download the latest release from the S2 Technologies ftp site: ftp://ftp.s2technologies.com <br /> <br /> To run STRIDE you will need a license. If you are not yet a customer of S2 and would like to obtain an evaluation license, email [mailto:sales@s2technologies.com S2 Sales] or call our offices at '''760-635-2345'''. <br /> <br /> = Installing the Software =<br /> <br /> To install STRIDE for the first time, or as an upgrade to an existing installation, please refer to [[Host Installation]]. <br /> <br /> {| border=&quot;1&quot;<br /> |-<br /> | <br /> Note that if you are upgrading from a previous installation '''you must uninstall your existing STRIDE''' before installing version 3.0.01xx. <br /> <br /> |}<br /> <br /> If you are new to STRIDE, we recommend that you investigate the [[Samples_Overview|New STRIDE Samples]].<br /> <br /> = Change Details =<br /> <br /> *The '''ascript''' API has been changed to be more robust: <br /> **Certain deprecated methods have been eliminated. <br /> **Some existing methods have had their APIs modifed. <br /> **The event model has been improved to allow greater script control.<br /> <br /> '''Note''': Some scripts must be modified from previous versions of STRIDE to work successfully with 3.0.01xx. The necessary changes are detailed in the [[#Migration_to_3.0.01xx|Migration to 3.0.01xx]] section below. <br /> <br /> *The '''Panel''' object is no longer available to scripts; its functionality has been moved under the '''studio''' object model. You can access this new functionality as '''studio.Connection''', however if you were formerly scripting the '''Panel''' object, you may find it is no longer necessary since: <br /> **You can now configure your connection properties from within STRIDE Studio (from the menu select ''Tools/Target Connectivity'') <br /> **You can now set a workspace folder property to autoconnect upon execution<br /> <br /> *Zero is now allowed as the maximum size under certain circumstances in '''scl_string''' and '''scl_ptr_sized'''. Details of these circumstances are contained in the '''[[Media:s2sSCLReferenceGuide.pdf|SCL Reference Guide]]''' document.<br /> <br /> *'''studio.Workspace.Compiler.MicrosoftCompatibility''' has been replaced with '''studio.Workspace.Compiler.Compatibility'''. Valid values are &quot;Generic&quot; (generic mode), &quot;Microsoft&quot; (Microsoft compatibility), or &quot;Gnu&quot; (Gnu or Gcc compatibility).<br /> <br /> *'''studio.Workspace.Compile()''' has been replaced with '''studio.Workspace.Build()'''. Also new methods, '''studio.Workspace.CleanBuild()''' and '''studio.Workspace.ReloadDatabase()''', have been added.<br /> <br /> *A new property, '''Output''', has been added off the studio object. This property outputs text to the Studio message tab, similar to how '''ascript.MessageBox()''' works for certain scripts. This property contains one method, '''PrintMessage(String msg)'''. You can see an example of its use [[Debugging Helps|here]].<br /> <br /> *A new settings group has been introduced - '''studio.Workspace.Settings.Build'''.<br /> <br /> *'''studio.Workspace.Intercept.Path''' has been replaced with '''studio.Workspace.Intercept.SourcePath''' and '''studio.Workspace.Intercept.HeaderPath'''.<br /> <br /> &lt;br&gt; <br /> <br /> == Fixes ==<br /> <br /> ''This section describes defects which have been corrected in STRIDE and the customer tracking number associated with them, if any, in brackets [].'' <br /> <br /> *[1055] Not able to specifiy uppercase include directory <br /> *[1163] Certain cases of array of pointers to discriminated unions that were not handled correctly in the ascript object have been fixed. <br /> *[1357] The ascript '''Call()''' method, when used with RspTimeoutPeriod, only returns True if a timeout has occurred. <br /> *[1469] Global casting using '''scl_cast''' no longer causes an intercept module compile error. <br /> *[1539] '''ascript''' no longer returns &quot;undefined&quot; when calling '''function.ReturnValue''' when the captured function returns an unqualified function pointer. <br /> *[1543] IM source file locations added to studio UI and automation <br /> *[1564] The Studio Add files dialog has been increased from 2K bytes to 100K bytes, to allow for more files to be selected at a time. <br /> *[1586] Support for Variadic Macros <br /> *[1597] EDGFront crash for scl_ptr_opaque <br /> *[1600] Pre-processor treats constant 1 always as 8-bit <br /> *[1605] Generated Perl script generates error when run in debugger <br /> *The following statement in Runtime files '''srtest.c''' and '''srtest.cpp''' has been changed:&lt;br&gt;&lt;tt&gt;va_list args = 0;&lt;/tt&gt;&lt;br&gt;is now&lt;br&gt;&lt;tt&gt;va_list args;&lt;/tt&gt;&lt;br&gt; with no initializer. This makes it portable and able to compile under Linux. <br /> *A macro that determines the existence of '''vsnprintf()''' has been updated in '''srtest.c''' and '''srtest.cpp''' in order to make it able to compile with GCC and other non-Microsoft compilers.&lt;br&gt;'''Note:''' If you are using test functions and C++ test classes, you must be using compilers that support '''vsnprintf''' (variable argument lists), which is a standard in C99 and supported in C90. <br /> *When tracing on a STID it's possible to display trace information for messages that aren't captured (i.e. the message's SMID is not known to STRIDE). A problem could occur when STRIDE attempted to interpret the payload of these messages. This has now been fixed; hex values only are now shown in the trace view for in this situation. <br /> *Autosense was not working properly in the editor for message payloads. This has been fixed.<br /> <br /> == AutoScript ==<br /> <br /> === TestUnits Collection ===<br /> <br /> A new TestUnits collection has been implemented. All test interfaces (specified with [[SCL_Pragmas#Test_Units | Test Unit pragmas]]) will be listed there.<br /> <br /> === Functions Collection ===<br /> <br /> Interfaces specified with either the [[scl_test_class]] or [[scl_test_flist]] pragmas are not listed in the Functions collection anymore. <br /> <br /> == PAL ==<br /> <br /> === Memory Management ===<br /> <br /> To support multi-process target, memory management support for dynamic, configurable, and internal static memory has been implemented in Runtime. Runtime makes PAL calls to acquire memory segments and manages the memory according to runtime configurations set by user. In case of multi-process target is enabled, these memory will be shared among multiple applications, and PAL should implement shared memory. <br /> <br /> === Protection using Mutex ===<br /> <br /> Runtime now uses named mutex objects to protect critical data from multiple and simultaneous accesses by multiple threads and, in case of multi-process target is enabled, by multiple applications. Runtime makes PAL calls to obtain and control mutex objects. <br /> <br /> === New Routines ===<br /> <br /> *'''Memory Management'''<br /> <br /> In case of multi-process target, recommended approach is to use &lt;u&gt;Memory-Mapped Files&lt;/u&gt; to implement memory segments. <br /> <br /> palMemSegmentOpen() - Open/create memory segment <br /> palMemSegmentClose() - Close memory segment<br /> <br /> *'''Named Mutexes'''<br /> <br /> palMutexInit() - Initialize a mutex object<br /> palMutexDestroy() - Destroy a mutex object<br /> palMutexLock() - Lock a mutex object<br /> palMutexUnlock() - Unlock a mutex object<br /> <br /> *'''Task Synchronization'''<br /> <br /> palGetThreadId() - Get current thread Id<br /> palGetProcessId() - Get current process Id<br /> palSleep() - Suspend the execution of the current thread<br /> <br /> *'''Logging'''<br /> <br /> This is optional. <br /> <br /> palLog() - Logging utility<br /> <br /> === Updated Routines ===<br /> <br /> *Function signatures and functionalities of palWait() &amp;amp; palNotify() have been updated.<br /> <br /> palWait() - now takes in an in/out pointer for events notification<br /> palNotify() - mail box Id has been updated to notify any event including mail box Ids.<br /> <br /> *Function signatures of palMemAlloc() &amp;amp; palMemFree() have been updated.<br /> <br /> === Removed Routines ===<br /> <br /> palProtect<br /> palUnprotect<br /> palCriticalErr<br /> <br /> === Removed Modules ===<br /> <br /> S2Mem - Memory module provided as part of PAL has been removed. If native OS does not support dynamic memory, Runtime's memory management module ''srMem'' can be used instead of ''S2Mem''.<br /> <br /> == Runtime ==<br /> <br /> *STRIDE Host Release '''3.0.01xx''' is compatible with the Runtime Version '''3.00'''. <br /> *In order to eliminate redundancy and promote an object-oriented design, &quot;Member Methods&quot; have been removed from srTest; only &quot;Member Objects&quot; exist now in srTest. In addition, accessing the functionality of Member Objects in this way is similar to accessing scripting objects through the STRIDE Reporter object model. For a detailed explanation, refer to [[Test_Units#C.2B.2B_Test_Classes|this article]] on the STRIDE Support Wiki. <br /> *A new routine, '''srInit()''', replaces deprecated '''srInitialize()'''. Now the target will not be able to set an auto-connect with timeout. <br /> *The '''scl_tp''' and '''scl_tp_format''' pragmas have been deprecated. The new pragmas are '''scl_tracepoint''' and '''scl_tracepoint_format'''. <br /> *The default runtime configuration in srcfg.h now has fragmentation turned on. The srCFG_MAX_TRANSPORT_UNIT is set to 2048. <br /> *Fixed warnings for parameter name differences in function declarations and definitions for srSubscribe(), srTracePoint(), and srQuerySMID(). <br /> *Removed unnecessary/extra response to srCONNECT_CLOSE_T_SMID message. <br /> *The Runtime now checks for the connection before responding with a &quot;Pong&quot; upon receiving a &quot;Ping.&quot; <br /> *Introduced 40 additional system trace points to better describe internal errors. <br /> *Reporting of the error srERR_SUB_NONE has been suppressed so that it no longer generates a target trace error. <br /> *Trace views now always display srTraceStr() with reserved STID (srSTID_RESERVED) regardless of trace filter settings. <br /> *srPtrSetupChild() now accepts NULL for handle (out pointer - pwHandle). <br /> *Added a new Runtime Test Services (RTS) API '''srTestCaseSetStatusEx()''', which enables the providing of the actual return value of a numeric test method in the case of failure. <br /> *Added two new public APIs - &quot;Printing&quot; APIs to display messages on Trace Views without having to specify a STID or a trace level and to set any trace filters on Trace Views. These routines support formatted strings with variable arguments. The '''srPrintInfo()''' will show as srTraceStr() with STID=0 and Level=3. The '''srPrintError()''' will show as srTraceStr() with STID=0 and the Level=1. '''Warning:''' These new APIs use vsnprintf() routine to process variable arguments. The vsnprintf() became a standard in C99 and is supported in C90. <br /> *To support multi-process target, significant changes have been made to runtime. <br /> *A new public routine, srUninit(), has been added to sr.h &amp;amp; srapi.c. <br /> * A new public routine for Runtime Thread exit point, srThreadUninit(), has been added to sr.h &amp;amp; srthread.c. <br /> *A new module, srMem, for Memory Management has been added. Its new routines, _srMem_Allocate() &amp;amp; _srMem_Free(), will be used in PAL's palMemAlloc() &amp;amp; palMemFree() in case of multi-process target is enabled. <br /> *Calls to palProtect() &amp;amp; palUnprotect() have been replaced by new routines _srProtect() &amp;amp; _srUnprotect(), in which the implementation uses its own mutex object that calls PAL's mutex routines. <br /> *In target Test Classes and Test Functions, added capability to specify the comment label in srTestCaseAddComment() and AddComment() APIs.<br /> * Fixed a potential data abort issue when executing delegate code in the IM prior to Runtime being initialized.<br /> * Runtime Test Services APIs are now thread safe. <br /> * Fixed cancelation of remote boadcast subcribtion goes in an infinite loop.<br /> * Fixed Runtime resource abuse when sending lots of broadcast messages. <br /> * Added partial check for message payload corectness.<br /> <br /> *''The following Runtime files have been modified:''<br /> <br /> sr.h<br /> srapi.c<br /> srapi.h<br /> srapirgl.c<br /> srapirgl.h<br /> srcfg.h<br /> srconn.c<br /> srconn.h<br /> srerr.c<br /> srib.c<br /> srib.h<br /> sribctrl.c<br /> sribtr.c<br /> sribtr.h<br /> srmsgmar.c<br /> srmsgptr.c<br /> srmsgptr.h<br /> srmsgque.c<br /> srmsgque.h<br /> srmsgrt.c<br /> srmsgrt.h<br /> srmsgsub.c<br /> srmsgsub.h<br /> srstid.c<br /> srstid.h<br /> srsuid.c<br /> srsuid.h<br /> srtest.c<br /> srtest.cpp<br /> srtest.c<br /> srtest.h<br /> srtestutil.c<br /> srtestutil.h<br /> srthread.c<br /> srthread.h<br /> srtime.c<br /> srtime.h<br /> srtp.h<br /> srutil.h<br /> <br /> *''The following Runtime files have been added:''<br /> <br /> srmem.c<br /> srmem.h<br /> <br /> = Migration to 3.0.01xx =<br /> <br /> Recommended steps for migration from a previous version: <br /> <br /> == AutoScript ==<br /> <br /> Any use of test classes through the Functions collection, like: <br /> <br /> $main::ascript-&amp;gt;Functions-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;User-&amp;gt;Call(); <br /> <br /> should be converted to use the new TestUnits collection: <br /> <br /> $main::ascript-&amp;gt;TestUnits-&amp;gt;Item(&quot;my_test_class&quot;)-&amp;gt;Run(); <br /> <br /> &lt;br&gt; <br /> <br /> === API Changes ===<br /> <br /> *The Support Wiki pages now contain reference help for AutoScript. The content has been updated to reflect the API changes, for details see the ''AutoScript API Reference''. <br /> *All synchronous method calls now throw exceptions in order to indicate error conditions rather than have error conditions encoded in return values. <br /> *Asychronous method calls never throw exceptions to indicate error conditions. Instead, error conditions are delivered as a new Error object that is returned to '''ascript.WaitForEvent()'''. (Asynchronous methods are '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()''') <br /> *If '''ascript.WaitForEvent()''' times out, an Error object is returned. Previously NULL was returned in this case. <br /> *All objects returned by '''ascript.WaitForEvent()''' have '''Type''' and '''Name''' properties. When the '''Type''' is “Error”, the Error object has additional properties that contain further details about the error. <br /> *All existing script syntax for designation of message payloads has been deprecated. A new syntax that allows for greater expression has been adopted. Details can be found [[Updated Message Payload Syntax|here]]. There are no syntax changes to function payloads. <br /> *The signature for '''ascript.Initialize''' has been changed. Successful calls to '''ascript.Initialize''' now fully initialize the object.<br /> <br /> === End-Of-Lifed Methods and Properties ===<br /> <br /> The following have been End-Of-Lifed (EOL'd). A call to any of these methods or an access to any of these properties will now result in a not-implemented exception in the script making the call or access. <br /> <br /> *ascript.Quit() <br /> *ascript.Interfaces <br /> *ascript.NamedEvents <br /> *ascript.WaitForEventWithTimeout <br /> *ascript.RspTimeoutNotifyEnabled <br /> *ascript.CreateTimer() <br /> *ascript.DestroyTimer() <br /> *ascript.WaitTimeoutNotifyEnabled <br /> *ascript.Compare_As_C_Values() <br /> *ascript.AsyncErrorNotifyEnabled <br /> *ascript.Function.Item().User/Owner.SMID<br /> <br /> === Recommended Steps for Migration From a Previous Version ===<br /> <br /> *Search for calls to '''ascript.WaitForEvent()''' in all scripts. Previous logic to test for null indicating timeouts must be modified. '''WaitForEvent()''' now always returns an object, in the case of a timeout (or other error) an Error object is returned. <br /> *Search for calls to '''ascript.Quit''' in all scripts. Modify the logic as necessary to exit the script by other means in place of the original '''Quit()''' call. <br /> *Search for all asynchronous method calls (Asynchronous calls are limited to '''function.Owner.Return()''', '''function.User.CallNonBlocking()''', '''function.User.CallBypassOverrideNonBlocking()''', '''message.Owner.Broadcast()''', '''message.Owner.SendRsp()''', '''message.User.SendCmd()''', and '''message.User.SendCmdBypassOverride()'''). Modify the logic as necessary to call '''ascript.WaitForEvent()''' if errors (including timeout error) should be detected. <br /> *If you have scripts that explicitly instantiate an '''ascript''' object (i.e. they create an object using the '''&quot;STRIDE.ascript&quot;''' PROGID), search for all occurrences and modify the subsequent call to '''ascript.Initialize()''' to pass the new parameter set. <br /> *Search for all EOL'd methods and properties. Each can be replaced by setting the appropriate timeout property and handling the timeout error object delivered by WaitForEvent.<br /> <br /> &lt;br&gt; <br /> &lt;div class=&quot;Section1&quot;&gt;<br /> {| width=&quot;100%&quot; border=&quot;1&quot; style=&quot;width: 100%; border-collapse: collapse;&quot; class=&quot;MsoTableGrid&quot;<br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border: 1pt solid windowtext; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''EOL’d'''&lt;/span&gt;'''Method or Property''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: solid solid solid none; border-color: windowtext windowtext windowtext -moz-use-text-color; border-width: 1pt 1pt 1pt medium; padding: 0in 5.4pt; background: rgb(204, 255, 204) none repeat scroll 0% 50%; width: 50%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;&quot; | <br /> '''Recommended Replacement''' <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Quit'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;Refactor&lt;/span&gt; script logic to exit the script by other means. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Interfaces'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Functions&lt;/span&gt; or &lt;span class=&quot;SpellE&quot;&gt;ascript.Messages&lt;/span&gt; as appropriate. <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.NamedEvents'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitForEventWithTimeout'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() after setting desired timeout using &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitTimeoutPeriod&lt;/span&gt; <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.RspTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.CreateTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Add&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.DestroyTimer'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Timers.Remove&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.WaitTimeoutNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Timeout notifications are performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Compare_As_C_Values'''&lt;/span&gt;'''()''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Contact S2 Technologies <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.AsyncErrorNotifyEnabled'''&lt;/span&gt; <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> No longer needed. Error notification from asynchronous calls is performed by returning an Error object from &lt;span class=&quot;SpellE&quot;&gt;ascript.WaitForEvent&lt;/span&gt;() <br /> <br /> |- style=&quot;&quot;<br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid; border-color: -moz-use-text-color windowtext windowtext; border-width: medium 1pt 1pt; padding: 0in 5.4pt; width: 50%;&quot; | <br /> &lt;span class=&quot;SpellE&quot;&gt;'''ascript.Function.Item'''&lt;/span&gt;'''().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SMID&lt;/span&gt;''' <br /> <br /> | width=&quot;50%&quot; valign=&quot;top&quot; style=&quot;border-style: none solid solid none; border-color: -moz-use-text-color windowtext windowtext -moz-use-text-color; border-width: medium 1pt 1pt medium; padding: 0in 5.4pt; width: 50%;&quot; | <br /> Use &lt;span class=&quot;SpellE&quot;&gt;ascript.Function.Item&lt;/span&gt;().User/&lt;span class=&quot;SpellE&quot;&gt;Owner.SUID&lt;/span&gt; <br /> <br /> |}<br /> &lt;/div&gt;<br /> <br /> == PAL ==<br /> <br /> Please refer to '''''Platform Abstraction Layer (PAL) Specification''''' for detailed information on new APIs. You may also refer to Linux implementation of PAL, which has been updated with new routines. <br /> <br /> *Implement new shared memory routines, palMemSegmentOpen() &amp;amp; palMemSegmentClose(). In case of multi-process target, these routines should implement shared memory using memory-mapped files.<br /> <br /> *Runtime now can manage dynamic, configurable, and internal static memory. In case of multi-process target, update palMemAlloc() to simply call _srMem_Allocate() and palMemFree() to simply call _srMem_Free(). In case of single-process target, you can simply allocate dynamic memory according to your Operating System. If you are upgrading, you can simply leave the current implementation as it is.<br /> <br /> *Implement new mutex routines, palMutexInit(), palMutexDestroy(), palMutexLock() &amp;amp; palMutexUnlock, to handle any named mutex objects. It is recommended to implement a separate code for shared memory case if it is necessary.<br /> <br /> *Remove old routines palProtect(), palUnprotect() and palCriticalErr().<br /> <br /> *Implement new routines palGetThreadId() and palGetProcessId().<br /> <br /> *Implement new routine palSleep().<br /> <br /> *Update synchronization routines, palCreateNID(), palDeleteNID(), palWait() &amp;amp; palNotify(), to support event notifications and in case of multi-process target is enabled, sharing of the synchronization objects among multiple processors.<br /> <br /> *If your PAL uses ''S2Mem'' routines for dynamic memory, you should use new Runtime module ''srMem''. Update palMemAlloc() to call _srMem_Allocate() and palMemFree() to call _srMem_Free().<br /> <br /> *Optionally, implement new routine palLog() as a logging utility for PAL and Runtime.<br /> <br /> == Runtime ==<br /> <br /> *Edit '''srcfg.h''' file to configure the new memory management (srCFG_MEMORY_MANAGEMENT) and multi-process target (srCFG_MULTI_PROC_TARGET) settings. By default, memory management and multi-process target are disabled. If you enable multi-process target you also need to enable memory management and configure the sizes and the maximum number of memory blocks. New Runtime module ''srMem'' uses these configurations to allocate and manage memory segments.<br /> <br /> *Edit '''srcfg.h''' file to configure the new target connection timeout setting (srCFG_CONNECTION_TIMEOUT).<br /> <br /> *If target Test Classes and Test Functions are used, change the signature to include test label in srTestCaseAddComment() and AddComment() APIs.<br /> <br /> == Windows Applications using Windows Off-Target SDK ==<br /> <br /> *The new '''s2srwin.lib''' has public API, published in a header srwin.h, containing the following set of routines:<br /> <br /> srWin_SetMaster() - Sets the application as the master and initializes the Stride Runtime thread. In a multi-process environment only one application should make this call.<br /> srWin_AddThread() - Adds additional message processing threads to the application.<br /> srWin_Run() - Starts the processing and will not return until it has been signaled via keyboard key or CTRL-C.<br /> srWin_SetPortTCP() - Overrides the TCP port number (default: 8000) to which the application will bind for the purpose of accepting connections.<br /> srWin_SetPortSerial() - Overrides the COM port number (default: 1) to which the application will bind for the purpose of accepting connections.<br /> <br /> *Existing Host Apps developed against the old hostapphrt and hostapptrt libraries should be updated to as follows: <br /> **replace the include of hostapp.h with include of srwin.h <br /> **replace all calls to HostAppXXX() with srWin_XXX() <br /> **call srWin_SetMaster() to start the runtime thread, srThread, before calling srWin_Run(). Within a multi-process target, only one process (the master) calls this routine.<br /> <br /> = Minor and Patch releases =<br /> == 3.0.0101 Patch &quot;a&quot; ==<br /> * Linux version of the STRIDE [[Build Tools]] is officially introduced.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0101 Patch &quot;b&quot; ==<br /> * Relaxed [[scl_cast]]() pragma to allow cast from any integral ptr to union of ptrs<br /> * Fixed compile warnings in Linux PAL.<br /> * Fixed issue in instrumentation of [[Test Units]].<br /> * Fixed issue with UNC paths.<br /> * Fixed several minor issues in [[STRIDE Studio]].<br /> <br /> == 3.0.0102 ==<br /> * Implemented new licensing scheme. Existing licenses will not work anymore and need to be reissued. Old and new licenses could co-exist at the same location.<br /> * The syntax of [[scl_ptr]] and [[scl_ptr_sized]] pragmas has changed. Now it is required to quote the direction and usage attributes. See this [[Handling_of_pointer_attribute_tokens|page]] for details.<br /> * [[Test_Units#Runtime_Test_Services|Runtime Test Services]] now support adding annotations per test suite.<br /> * A complete set of [[Samples]] has been implemented.<br /> * Fixed several minor issues in STRIDE [[Build Tools]].<br /> * In [[STRIDE Studio]] the processing of Trace information has been optimized.<br /> * Fixed several minor issues in [[STRIDE Studio]]. <br /> * Fixed several minor issues in [[AutoScript]]. <br /> * STRIDE Host Release '''3.0.0102''' is compatible with the Runtime Versions '''3.00''' and '''3.01'''.<br /> *''The following Runtime files have been modified:''<br /> <br /> srconn.c<br /> srtest.c<br /> srtest.cpp<br /> srtest.h<br /> <br /> <br /> <br /> [[Category:3.0.01xx]]<br /> [[Category:Release Notes]]</div>

Chrisj