Difference between revisions of "Desktop Installation"

From STRIDE Wiki
Jump to: navigation, search
Line 65: Line 65:
 
= Installed Directories and Files =
 
= Installed Directories and Files =
  
Here is a quick orientation to the directories and files that are installed.
+
It's not necessary to understand the workings of the STRIDE framework to perform sandbox evaluation or training. The SDK is set up with appropriate options and settings to enable "out of the box" functionality. A quick orientation to the sandbox directories and files is shown below.
 +
 
 +
If you are interested in the details, consult the articles [[Linux SDK]] and [[Windows SDK]].
  
 
===<tt>bin</tt>===
 
===<tt>bin</tt>===
Line 78: Line 80:
  
 
===<tt>SDK</tt>===
 
===<tt>SDK</tt>===
This directory contains the subdirectories <tt>GRS</tt>, <tt>Runtime</tt>, and <tt>SLAP</tt>, which contain source code that comprises the STRIDE Runtime.
+
This directory contains the subdirectories <tt>GRS</tt>, <tt>Runtime</tt>, and <tt>SLAP</tt>, which contain source code that comprises the STRIDE Runtime. These sources are built into the STRIDE Runtime library as a dependency of the <tt>testapp</tt> target. (See <tt>src</tt> directory below.)
  
In addition, there is a Directory named either <tt>Linux</tt> or <tt>Windows</tt>, depending on your host operating system.
+
In addition, there is a directory named either <tt>Linux</tt> or <tt>Windows</tt>, depending on your host operating system.
  
 
====<tt>SDK\Windows</tt> or <tt>SDK/Linux</tt>====
 
====<tt>SDK\Windows</tt> or <tt>SDK/Linux</tt>====
 +
This directory (<tt>Windows</tt> or <tt>Linux</tt> contains the following directories:
  
;<tt>bin</tt> ''(Windows only)''
+
*;<tt>bin</tt> ''(Windows only)''
 
: Contains GNU make program files (GNU make is already present on Linux systems)
 
: Contains GNU make program files (GNU make is already present on Linux systems)
;<tt>sample_src</tt>
+
*;<tt>sample_src</tt>
:
+
: This directory is originally empty. The sandbox is set up so that any files in this directory are included in the TestApp build.
;<tt>settings</tt>
+
*;<tt>settings</tt>
:
+
: This directory contains the single file <tt>stride.s2scompile</tt>. This file, used by the <tt>s2scompile</tt> program, specifies target CPU characteristics (endian-ness, data sizes and alignments). Since the SDK targets an x86 processor, its characteristics are reflected in the file. 
;<tt>src</tt>
+
*;<tt>src</tt>
:
+
: This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
 +
*;''<tt>out</tt>''
 +
: This directory (and several subdirectories) is created as part of the make process. All of the make targets are written to this directory and its subdirectories.
  
  
== Related Topics ==
 
* [[Activating Your STRIDE License]]
 
* [[Stride_Runner#Environment_Variables|Environment Variable Setup]]
 
  
 
[[Category:Deployment]]
 
[[Category:Deployment]]
 
[[Category:Sandbox & Training]]
 
[[Category:Sandbox & Training]]

Revision as of 12:34, 8 September 2009

To perform Sandbox Evaluation & Training, you need to install the STRIDE Framework package on your PC. Prior to version 4.1.02 (released in October 2009), the framework was distributed using a set of four separate archives. Starting with version 4.1.02 the framework is distributed as a single archive. For installation instructions for the earlier version, please see Package Installation for Version 4.1.01.

Installation Packages

Files are installed by unzipping the provided package to your PC. Packages are available targeting the following operating systems (your version number may be different than that shown):

Windows XP
STRIDE_framework-windows_4.1.02.zip
Linux
STRIDE_framework-linux_4.1.02.zip

Please see the appropriate installation instructions below.

Linux Installation

Unzip the Installation Package

  1. Create a directory named stride in your home directory.
  2. Unzip the package to the stride directory

For example:

cd ~/stride
unzip ../STRIDE_framework-linux_4.1.02.zip

Note: This assumes that the installation package is located in your home directory and that the directory ~/stride exists. The version numbers in your archive file name may be different than those shown in the example.

Set Execute Mode on STRIDE Executable Files

In order to be able to execute the STRIDE-related programs, you must set the execute bit on the following files in the ~/stride/bin directory:

  • doxygen
  • s2sbind
  • s2scompile
  • s2scpfe
  • s2sinstrument
  • stride

For example:

cd ~/stride/bin
chmod +x doxygen stride s2*


Update Your PATH

As a final step, you will need to update your PATH environment variable to include ~/stride/bin.

If you use the bash shell, enter the following at a command prompt, or to automatically set at each login, add to your .bashrc:

export PATH=$PATH:~/stride/bin

For other shells, and more information, please see the following articles:

Windows Installation

The following installation example assumes the the installation package is located in your root directory and that the directory \stride exists. The version numbers in your archive file name may be different than those shown in the example.

The example uses the open source 7-Zip utility to unzip the archive.

cd \stride
"\Program Files\7-Zip\7z" x ..\STRIDE_framework-windows_4.1.02.zip

Once unzipped, files will have been installed under the \stride directory.

Updating Your PATH

As a final step, you must update your PATH environment variable to include \stride\bin.

For instructions, please see http://support.microsoft.com/kb/310519.

Installed Directories and Files

It's not necessary to understand the workings of the STRIDE framework to perform sandbox evaluation or training. The SDK is set up with appropriate options and settings to enable "out of the box" functionality. A quick orientation to the sandbox directories and files is shown below.

If you are interested in the details, consult the articles Linux SDK and Windows SDK.

bin

This directory contains the STRIDE Build Tools and the STRIDE Runner.

The build tools are invoked early on in the target software build process to generate special STRIDE artifacts that are used in subsequent build steps and later when running tests against the target. In a sandbox installation, these files are needed on the host computer since this is where we are building the target application. In a production off-target environment, these files are needed only on the computer that performs the target software build.

The STRIDE Runner is the program you use to run tests from the host.

Samples

The Samples directory contains a number of subdirectories, each containing the source for a sample test.

SDK

This directory contains the subdirectories GRS, Runtime, and SLAP, which contain source code that comprises the STRIDE Runtime. These sources are built into the STRIDE Runtime library as a dependency of the testapp target. (See src directory below.)

In addition, there is a directory named either Linux or Windows, depending on your host operating system.

SDK\Windows or SDK/Linux

This directory (Windows or Linux contains the following directories:

  • bin (Windows only)
Contains GNU make program files (GNU make is already present on Linux systems)
  • sample_src
This directory is originally empty. The sandbox is set up so that any files in this directory are included in the TestApp build.
  • settings
This directory contains the single file stride.s2scompile. This file, used by the s2scompile program, specifies target CPU characteristics (endian-ness, data sizes and alignments). Since the SDK targets an x86 processor, its characteristics are reflected in the file.
  • src
This directory contains the Makefile used to produce the sandbox TestApp as well as the TestApp sources.
  • out
This directory (and several subdirectories) is created as part of the make process. All of the make targets are written to this directory and its subdirectories.