Difference between revisions of "STRIDE Extensions for Visual Studio"

From STRIDE Wiki
Jump to: navigation, search
 
(73 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Introduction ==  
 
== Introduction ==  
−
If you are using the STRIDE desktop Framework for windows, an alternative to the [[Off-Target_Test_App | standard method]] of building test apps (using ''make'') is to use the STRIDE Rules file for Visual Studio.
+
The Stride Extensions for Visual Studio can be used to integrate directly into your existing Visual Studio C/C++ project.
  
 
== Prerequisites ==
 
== Prerequisites ==
−
* Visual Studio 2005 or later (an express distribution is fine)
+
* Visual Studio 2008 or later (an express distribution is fine)
−
* recent version of perl must be in your path
+
* a recent version of the Stride installed
−
* a recent version of the STRIDE desktop Framework [[Desktop Installation |installed]]
+
* a static library version of the runtime built using the source files included in the [[Windows_SDK | Windows SDK]]
−
* a static library version of the runtime built using the source files included in the [[Windows_SDK | SDK]]. This is accomplished by just running ''make'' on the makefile that we provide in the <tt>SDK\Windows\src</tt> directory (the default makefile target builds the static runtime library).
+
** to build the library open a [http://msdn.microsoft.com/en-us/library/ms235639(v=vs.100).aspx Visual Studio Command Prompt] and do as follows:
 +
<pre>
 +
> md %STRIDE_DIR%\SDK\Windows\lib
 +
> cd %STRIDE_DIR%\SDK\Windows\src
 +
> ..\bin\make clean
 +
> ..\bin\make RTSINGLEPROC=0
 +
> copy %STRIDE_DIR%\SDK\Windows\out\lib\stride-x86-Windows_NT.lib %STRIDE_DIR%\SDK\Windows\lib\stride.lib
 +
> ..\bin\make clean
 +
> ..\bin\make RTSINGLEPROC=0 DEBUG=1
 +
> copy %STRIDE_DIR%\SDK\Windows\out\lib\stride-x86-Windows_NT-d.lib %STRIDE_DIR%\SDK\Windows\lib\stride-d.lib
 +
</pre>
 +
* an existing C/C++ Visual Studio project
 +
** or you can easily create a new one, e.g. "Win32 Console Application", by using the project wizard provided within Visual Studio.
 +
 
 +
== Installation ==
 +
STRIDE Extensions need to be added to any project that is to generate ''intercept module''.  
  
−
== Creating Off-Target Test App Projects  ==
+
=== Visual Studio 2010 (or newer) ===
 +
* Right click on the project in the '''Solution Explorer''' window and choose '''Build Customizations…''' from the menu that is displayed.
 +
* In the dialog that is displayed, click '''Find Existing…''' and select '''$(STRIDE_DIR)\SDK\Windows\settings\stride.targets''' (if asked, say “No” to adding to standard “Build Customizations Search Path”)
 +
* Make sure the check box next to '''stride''' is ''enabled''.
  
−
The following instructions describe the steps required to create sandbox target applications on windows. You will likely need additional source code and project settings as required to make your specific application code build.
+
=== Visual Studio 2008 ===
 +
<u>''NOTE:''</u> ''Due to limitations in Visual Studio 2008 the STRIDE integration is much more complicated compared to new versions. We recommend upgrading to Visual Studio 2010 or newer.''
  
−
<ol>
+
* Right click on the project in the '''Solution Explorer''' window and choose '''Build Custom Build Rules...''' from the menu that is displayed.
−
<li>Create a new C/C++ Win32 Console application project. All versions of Visual Studio provide a project wizard to do this. If you are given an option to use precompiled headers in the project, select '''No'''.</li>
+
* In the dialog that is displayed, click '''Find Existing…''' and select '''$(STRIDE_DIR)\SDK\Windows\settings\stride.rules''' (if asked, say “No” to adding to standard “Rule Files Search Path”)
−
<li>Assign the stride rules file to this project. Select the ''Custom Build Rules...'' menu item to launch a dialog to import this rules file located at ''stride\SDK\Windows\settings\stride.rules''. After associating the stride rules file with your project, make sure you also ''enable'' the rule for your project (typically by selecting the check-box next to it's name).</li>
+
* Make sure the check box next to '''STRIDE Rules''' is ''enabled''.
−
<li>Add your application, test and SCL source code to the project.
 
  
−
Any header files that are in the project will be automatically processed by the STRIDE SCL compiler.  If there are some header files that contain no SCL statements, then we recommend disabling the build step for these files. This is typically done via the properties dialog for a file by setting the "General" | "Exclude from build" property to "Yes".  
+
== Configuration ==
 +
The STRIDE Extensions execute a set of pre-build steps on your header files that generate test harnessing code that is later compiled in your application. To support the pre-build steps your global project settings require updating.  
  
−
In order to get an appropriate ''main'' function, you will also need to add the <tt>stride\SDK\Windows\src\TestApp.c</tt> to the project.</li>
+
=== Project Properties ===
−
<li>Change the C/C++ Properties for the project:
+
Adjust your project properties to compile and link with the STRIDE Runtime and generated test harnessing code.
−
<ul>
+
 
−
<li>Disable detection of 64-bit portability issues [typically found in the ''General'' section].</li>
+
<u>''NOTE:''</u> ''Make sure to apply the following changes to all project's configurations (e.g. Debug, Release).''
−
<li>set the runtime library to '''Multi-threaded DLL (/MD)''' [typically found in the ''Code Generation'' section].</li>
+
 
−
<li>Add Additional Include Directories to your project [typically found in the ''Preprocessor'' section]:
+
==== C/C++ Properties ====
 +
* Right click on the project in the '''Solution Explorer''' window and choose '''Properties''' from the menu that is displayed.  
 +
* From the properties dialog, select '''Configuration Properties | C/C++ | General''' from the tree view in the left pane.
 +
* From the right pane, add to '''Additional Include Directories''' the following:
 
<pre>
 
<pre>
 
$(STRIDE_DIR)\SDK\Runtime
 
$(STRIDE_DIR)\SDK\Runtime
 
$(STRIDE_DIR)\SDK\Windows\src
 
$(STRIDE_DIR)\SDK\Windows\src
−
[path(s) to other application and test source headers]
+
</pre>
−
</pre></li>
+
* Select '''Configuration Properties | C/C++ | Preprocessor''' from the tree view in the left pane.
−
<li>Add the following to the preprocessor definitions [typically found in the ''Preprocessor'' section]:
+
* From the right pane, add to '''Preprocessor Definitions''' the following:
 
<pre>
 
<pre>
−
STANDALONE_TESTAPP
+
STRIDE_ENABLED
−
STRIDE_ENABLED
 
 
STRIDE_STATIC
 
STRIDE_STATIC
 +
srCOMPLEX_TARGET
 
</pre>
 
</pre>
−
</li>
+
* Select '''Configuration Properties | C/C++ | Code Generation''' from the tree view in the left pane.
−
<li>Disable precompiled headers for the project (or selectively disable them for STRIDE-generated files) [typically found in the ''Precompiled Headers'' section].</li>
+
* From the right pane, set '''Runtime Library''' to '''Multi-threaded DLL (/MD)''' (or '''Multi-threaded Debug DLL (/MDd)''' for Debug configuration).
−
</ul>
 
−
</li>
 
  
−
<li>Change the Linker Properties for the project:
+
==== Linker Properties ====
−
<ul>
+
* Right click on the project in the '''Solution Explorer''' window and choose '''Properties''' from the menu that is displayed.
−
<li>Add Additional Library Directories [typically found in the ''General'' section]:
+
* From the properties dialog, select '''Configuration Properties | Linker | General''' from the tree view in the left pane.
 +
* From the right pane, add to '''Additional Library Directories''' the following:
 +
;If you built stride.lib from the makefile in the SDK
 
<pre>
 
<pre>
−
$(STRIDE_DIR)\SDK\Windows\out\lib
+
$(STRIDE_DIR)\SDK\Windows\lib
−
</pre></li>
+
</pre>
−
<li>Add Additional (linker) Dependency [typically found in the ''Input'' section]:
+
 
 +
* Select '''Configuration Properties | Linker | Input''' from the tree view in the left pane.
 +
* From the right pane, add to '''Additional Dependencies''' the following:
 
<pre>
 
<pre>
 
stride.lib
 
stride.lib
−
ws2_32.lib 
+
ws2_32.lib
−
winmm.lib
+
</pre>
−
</pre></li>
+
<u>''NOTE:''</u> ''For Debug configuration please specify "stride-d.lib".''
−
</ul>  
+
 
−
</li> 
+
=== Sort Out Header Files ===
 +
Every header file in the project that has [[Test Pragmas]] will cause harnessing code to be generated when processed by the STRIDE compiler. (Other non-stride header files can also be processed by the STRIDE compiler, but this only results in longer compile times.)
 +
 
 +
For each header file to be used as input to the STRIDE rules:
 +
* Right click on the header file in the '''Solution Explorer''' window and choose '''Properties''' from the menu that is displayed.
 +
* From the properties dialog, select '''Configuration Properties | General''' from the tree view in the left pane.
 +
* From the right pane, set the '''Item Type''' property to '''STRIDE Compile-Instrument'''.
 +
 
 +
If there are any header files that contain no test code declarations, then we recommend disabling the build step for these files. This could be done in the last step from above by setting the '''Item Type''' to '''C/C++ header''' or by setting '''Exclude From Build''' property to '''Yes'''. Remember as you add more header source files to the project, they will be automatically processed by STRIDE unless you explicitly disable.
 +
 
 +
=== STRIDE Compile-Instrument Properties ===
 +
 
 +
==== Visual Studio 2010 (or newer) ====
 +
 
 +
The default settings are usually sufficient so you don't need to make any changes.
 +
 
 +
When you build your project, notice that:
 +
* The STRIDE build tools automatically run and generate a STRIDE database (.sidb) file and intercept module (IM) source files. By default the names are derived from '''$(TargetName)''', and the associated files are written to the '''$(ProjectDir)''' directory.
 +
* The IM source, ''$(TargetName)IM.cpp'', is automatically compiled and linked along with your other project sources.
  
−
<li>Set the STRIDE Compile-Instrument properties for the project:
+
If you desire to change the ''Database Name'' and/or the ''Intercept Module Name'' use the following steps:
−
<ul>
+
* Right click on the project in the '''Solution Explorer''' window and choose '''Properties''' from the menu that is displayed.
−
<li>Set the '''Compile Options File''' to ''$(STRIDE_DIR)\SDK\Windows\settings\stride.s2scompile''.  This file provides basic options for windows off-target apps.  If you require different or additional parameters to be passed to the STRIDE SCL compiler, then we recommend that you make a local copy of the provided settings file and set this property to your private (and modified) version. The size and alignment settings in the provided file are correct for standard 32 bit Windows platforms.</li>
+
* From the properties dialog, select '''Configuration Properties | STRIDE Compile-Instrument'''
−
<li>The default Intercept generation assumes STUB settings for all captured functions. If you require different settings for any of your interfaces, you should create a text file containing the [[S2sinstrument#Options|additional settings]] to assign the path to this file for the '''Intercept Options File''' property.</li>
+
* Update '''Database Name''' and/or the '''Intercept Module Name''' right pane values as desired.  
−
<li>Add directories to the '''Include Directory''' property as needed to allow the STRIDE SCL compiler to process your source code. You can often use the same values here that you have previously set in the C/C++ compiler settings for your project.</li>
+
 
−
<li>Add preprocessor defines to the '''Defines''' property as needed to allow the STRIDE SCL compiler to process your source code. You can often use the same values here that you have previously set in the C/C++ compiler settings for your project.</li>
+
<u>''NOTE:''</u> ''If you do not see '''STRIDE Compile-Instrument''' try [[#Sort_Out_Header_Files | adding a header file]] to your project.''
−
</ul>
+
 
−
</li>
+
The default harness generation assumes STUB settings for all captured functions. If you require different settings for any of your interfaces, you should create a text file containing the [[S2sinstrument#Options|additional settings]] and specify it as follows:
−
<li>Repeat steps 4-6 for all project configurations you want to build (e.g., Debug, Release).</li>
+
* Right click on the project in the '''Solution Exporer''' window and choose '''Properties''' from the menu that is displayed.
−
<li>Build your project once to generate the STRIDE intercept module source files. You will get linker errors during this build since you have not yet added the generated STRIDE intercept code.</li>
+
* From the properties dialog, select '''Configuration Properties | STRIDE Compile-Instrument | Command Line''' from the tree view in the left pane.
−
<li>Add the generated source file - '''strideIM.cpp''' - to your project. This file will be located in the $(ProjectDir) directory. If you are using the STRIDE rules file (as described in step 2 above), you also need to add the following generated header files to your project: '''strideIM.h''' and '''strideIMEntry.h'''. Since these header files are generated, we do not want the STRIDE rule to attempt to process them (rather, they are in the project so that Visual Studio can properly calculate dependencies). As such, you should also set the ''Excluded from build'' property on these two header files to '''yes''' (this property is accessible by right clicking on the header file in the solution explorer view and selecting ''Properties'')</li>
+
* From the right pane, add to '''Additional Options''' property in the right pane.
−
<li>Rebuild your project and resolve any compiler errors/warnings.</li>
+
<pre>
 +
--intercept_options_file="path\to\my\file.s2instrument"
 +
</pre>
 +
 
 +
==== Visual Studio 2008 ====
 +
* Right click on the project in the '''Solution Exporer''' window and choose '''Properties''' from the menu that is displayed.
 +
* From the properties dialog, select '''Configuration Properties | STRIDE Compile-Instrument | Compile''' from the tree view in the left pane.
 +
* From the right pane, add to '''Compile Options Files''' the following:
 +
<pre>
 +
$(STRIDE_DIR)\SDK\Windows\settings\stride.s2scompile
 +
</pre>
 +
* From the right pane, update '''Include Directories''' to be exactly the same the one specified in '''Additional Include Directories''' in '''Configuration Properties | C/C++ | General''' section.
 +
* From the right pane, update '''Preprocessor Definitions''' to be exactly the same the one specified in '''Preprocessor Definitions''' in '''Configuration Properties | C/C++ | Preprocessor''' section.
 +
* Build your project once to generate the STRIDE database (.sidb) and intercept module (IM) source files. Notice, that you will get linker errors during this build since you have not yet added the generated IM source to the project.
 +
* From the '''$(ProjectDir)''' directory add the generated IM source file - '''strideIM.cpp''', '''strideIM.h''' and '''strideIMEntry.h''' - to your project.  
 +
** For '''strideIM.cpp''' make sure to set its '''Create/Use Precompiled Header''' property to '''Not Using...'''.
 +
** For '''strideIM.h''' and '''strideIMEntry.h''' make sure to set their '''Excluded From Build''' property to '''Yes''' as specified [[#Sort_Out_Header_Files|above]].
 +
* Rebuild your project and resolve any compiler errors/warnings.
 +
 
 +
The default harness generation assumes STUB settings for all captured functions. If you require different settings for any of your interfaces, you should create a text file containing the [[S2sinstrument#Options|additional settings]] and specify it as follows:
 +
* Right click on the project in the '''Solution Exporer''' window and choose '''Properties''' from the menu that is displayed.
 +
* From the properties dialog, select '''Configuration Properties | STRIDE Compile-Instrument | Instrument''' from the tree view in the left pane.
 +
* From the right pane, add to '''Intercept Options File''' property in the right pane.
 +
<pre>
 +
path\to\my\file.s2instrument
 +
</pre>
  
−
<u>''NOTE:''</u> As you add more header source files to the project, they will be automatically processed by the stride compiler unless you explicitly exclude them from the build.  As you add sources, you will likely also need to add additional include and preprocessor defines to the STRIDE compile-instrument settings in order to successfully build.
+
<u>''NOTE:''</u> ''As you add sources, you will likely also need to add Additional Includes and Preprocessor Defines to the project's STRIDE Compile-Instrument settings in order to successfully build.''
−
</ol>
 
  
 +
== Update Your Startup ==
  
−
[[Category: Installation]]
+
Update your application's main function to initialize the STRIDE subsystem as described in [[Windows_SDK#Target_Integration | this article]]. <u>''Note''</u> ''that the sample code assumes you have generated your Intercept Module with a name of '''myintercept'''. Make sure to replace any reference to that token in the code to the name you  [[#STRIDE_Compile-Instrument_Properties | chose above]].''

Latest revision as of 13:32, 7 January 2016

Introduction

The Stride Extensions for Visual Studio can be used to integrate directly into your existing Visual Studio C/C++ project.

Prerequisites

  • Visual Studio 2008 or later (an express distribution is fine)
  • a recent version of the Stride installed
  • a static library version of the runtime built using the source files included in the Windows SDK 
> md %STRIDE_DIR%\SDK\Windows\lib
> cd %STRIDE_DIR%\SDK\Windows\src
> ..\bin\make clean
> ..\bin\make RTSINGLEPROC=0
> copy %STRIDE_DIR%\SDK\Windows\out\lib\stride-x86-Windows_NT.lib %STRIDE_DIR%\SDK\Windows\lib\stride.lib
> ..\bin\make clean
> ..\bin\make RTSINGLEPROC=0 DEBUG=1
> copy %STRIDE_DIR%\SDK\Windows\out\lib\stride-x86-Windows_NT-d.lib %STRIDE_DIR%\SDK\Windows\lib\stride-d.lib
  • an existing C/C++ Visual Studio project
    • or you can easily create a new one, e.g. "Win32 Console Application", by using the project wizard provided within Visual Studio.

Installation

STRIDE Extensions need to be added to any project that is to generate intercept module.

Visual Studio 2010 (or newer)

  • Right click on the project in the Solution Explorer window and choose Build Customizations… from the menu that is displayed.
  • In the dialog that is displayed, click Find Existing… and select $(STRIDE_DIR)\SDK\Windows\settings\stride.targets (if asked, say “No” to adding to standard “Build Customizations Search Path”)
  • Make sure the check box next to stride is enabled.

Visual Studio 2008

NOTE: Due to limitations in Visual Studio 2008 the STRIDE integration is much more complicated compared to new versions. We recommend upgrading to Visual Studio 2010 or newer.

  • Right click on the project in the Solution Explorer window and choose Build Custom Build Rules... from the menu that is displayed.
  • In the dialog that is displayed, click Find Existing… and select $(STRIDE_DIR)\SDK\Windows\settings\stride.rules (if asked, say “No” to adding to standard “Rule Files Search Path”)
  • Make sure the check box next to STRIDE Rules is enabled.

Configuration

The STRIDE Extensions execute a set of pre-build steps on your header files that generate test harnessing code that is later compiled in your application. To support the pre-build steps your global project settings require updating.

Project Properties

Adjust your project properties to compile and link with the STRIDE Runtime and generated test harnessing code.

NOTE: Make sure to apply the following changes to all project's configurations (e.g. Debug, Release).

C/C++ Properties

  • Right click on the project in the Solution Explorer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | C/C++ | General from the tree view in the left pane.
  • From the right pane, add to Additional Include Directories the following:
$(STRIDE_DIR)\SDK\Runtime
$(STRIDE_DIR)\SDK\Windows\src
  • Select Configuration Properties | C/C++ | Preprocessor from the tree view in the left pane.
  • From the right pane, add to Preprocessor Definitions the following:
STRIDE_ENABLED
STRIDE_STATIC
srCOMPLEX_TARGET
  • Select Configuration Properties | C/C++ | Code Generation from the tree view in the left pane.
  • From the right pane, set Runtime Library to Multi-threaded DLL (/MD) (or Multi-threaded Debug DLL (/MDd) for Debug configuration).

Linker Properties

  • Right click on the project in the Solution Explorer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | Linker | General from the tree view in the left pane.
  • From the right pane, add to Additional Library Directories the following:
If you built stride.lib from the makefile in the SDK
$(STRIDE_DIR)\SDK\Windows\lib
  • Select Configuration Properties | Linker | Input from the tree view in the left pane.
  • From the right pane, add to Additional Dependencies the following:
stride.lib
ws2_32.lib

NOTE: For Debug configuration please specify "stride-d.lib".

Sort Out Header Files

Every header file in the project that has Test Pragmas will cause harnessing code to be generated when processed by the STRIDE compiler. (Other non-stride header files can also be processed by the STRIDE compiler, but this only results in longer compile times.)

For each header file to be used as input to the STRIDE rules:

  • Right click on the header file in the Solution Explorer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | General from the tree view in the left pane.
  • From the right pane, set the Item Type property to STRIDE Compile-Instrument.

If there are any header files that contain no test code declarations, then we recommend disabling the build step for these files. This could be done in the last step from above by setting the Item Type to C/C++ header or by setting Exclude From Build property to Yes. Remember as you add more header source files to the project, they will be automatically processed by STRIDE unless you explicitly disable.

STRIDE Compile-Instrument Properties

Visual Studio 2010 (or newer)

The default settings are usually sufficient so you don't need to make any changes.

When you build your project, notice that:

  • The STRIDE build tools automatically run and generate a STRIDE database (.sidb) file and intercept module (IM) source files. By default the names are derived from $(TargetName), and the associated files are written to the $(ProjectDir) directory.
  • The IM source, $(TargetName)IM.cpp, is automatically compiled and linked along with your other project sources.

If you desire to change the Database Name and/or the Intercept Module Name use the following steps:

  • Right click on the project in the Solution Explorer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | STRIDE Compile-Instrument
  • Update Database Name and/or the Intercept Module Name right pane values as desired.

NOTE: If you do not see STRIDE Compile-Instrument try adding a header file to your project.

The default harness generation assumes STUB settings for all captured functions. If you require different settings for any of your interfaces, you should create a text file containing the additional settings and specify it as follows:

  • Right click on the project in the Solution Exporer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | STRIDE Compile-Instrument | Command Line from the tree view in the left pane.
  • From the right pane, add to Additional Options property in the right pane.
--intercept_options_file="path\to\my\file.s2instrument"

Visual Studio 2008

  • Right click on the project in the Solution Exporer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | STRIDE Compile-Instrument | Compile from the tree view in the left pane.
  • From the right pane, add to Compile Options Files the following:
$(STRIDE_DIR)\SDK\Windows\settings\stride.s2scompile
  • From the right pane, update Include Directories to be exactly the same the one specified in Additional Include Directories in Configuration Properties | C/C++ | General section.
  • From the right pane, update Preprocessor Definitions to be exactly the same the one specified in Preprocessor Definitions in Configuration Properties | C/C++ | Preprocessor section.
  • Build your project once to generate the STRIDE database (.sidb) and intercept module (IM) source files. Notice, that you will get linker errors during this build since you have not yet added the generated IM source to the project.
  • From the $(ProjectDir) directory add the generated IM source file - strideIM.cpp, strideIM.h and strideIMEntry.h - to your project.
    • For strideIM.cpp make sure to set its Create/Use Precompiled Header property to Not Using....
    • For strideIM.h and strideIMEntry.h make sure to set their Excluded From Build property to Yes as specified above.
  • Rebuild your project and resolve any compiler errors/warnings.

The default harness generation assumes STUB settings for all captured functions. If you require different settings for any of your interfaces, you should create a text file containing the additional settings and specify it as follows:

  • Right click on the project in the Solution Exporer window and choose Properties from the menu that is displayed.
  • From the properties dialog, select Configuration Properties | STRIDE Compile-Instrument | Instrument from the tree view in the left pane.
  • From the right pane, add to Intercept Options File property in the right pane.
path\to\my\file.s2instrument

NOTE: As you add sources, you will likely also need to add Additional Includes and Preprocessor Defines to the project's STRIDE Compile-Instrument settings in order to successfully build.

Update Your Startup

Update your application's main function to initialize the STRIDE subsystem as described in this article. Note that the sample code assumes you have generated your Intercept Module with a name of myintercept. Make sure to replace any reference to that token in the code to the name you chose above.

Retrieved from "https://www.stridewiki.com/index.php?title=STRIDE_Extensions_for_Visual_Studio&oldid=14675"