Installation and Configuration Guide Version 2.0 1998-2006 Cadence Design Systems, Inc. All rights reserved worldwide. Printed in the United States of America. Cadence Design Systems, Inc. (Cadence), 2655 Seely Ave., San Jose, CA 95134, USA. Incisive Manager contains technology licensed from, and copyrighted by: Thai Open Source Software Center Ltd, Sukhumvit Soi 21 Bangkok 10110 Thailand, and Clark Cooper, and is 1998, 1999, 2000, Thai Open Source Software Center Ltd and Clark Cooper. All rights reserved. Expat maintainers and is 2001, 2002, 2003, Expat maintainers. All rights reserved. University of California, Oakland, California 94607 USA, and is 1990, The Regents of the University of California. All rights reserved. Sun Microsystems, Inc. and is Sun Microsystems, Inc. All rights reserved. Scriptics Corporation and is Scriptics Corporation. All rights reserved. Open Source Initiative and is 2004 by the Open Source Initiative. All rights reserved. University of Colorado, Boulder, CO 80309 USA, and is 1995-2004, Regents of the University of Colorado. All rights reserved. loi Kim Lam and is 1993-1995, loi Kim Lam. All rights reserved. Expert Interface Technologies and is 1996, Expert Interface Technologies. All rights reserved. Free Software Foundation, Inc., Boston, MA, and is 1989, 1991 Free Software Foundation, Inc. All rights reserved. Trademarks: Trademarks and service marks of Cadence Design Systems, Inc. contained in this document are attributed to Cadence with the appropriate symbol. For queries regarding Cadences trademarks, contact the corporate legal department at the address shown above or call 800.862.4522. All other trademarks are the property of their respective holders. Restricted Permission: This publication is protected by copyright law and international treaties and contains trade secrets and proprietary information owned by Cadence. Unauthorized reproduction or distribution of this publication, or any portion of it, may result in civil and criminal penalties. Except as specified in this permission statement, this publication may not be copied, reproduced, modified, published, uploaded, posted, transmitted, or distributed in any way, without prior written permission from Cadence. Unless otherwise agreed to by Cadence in writing, this statement grants Cadence customers permission to print one (1) hard copy of this publication subject to the following conditions: 1. The publication may be used only in accordance with a written agreement between Cadence and its customer; 2. The publication may not be modified in any way; 3. Any authorized copy of the publication or portion thereof must include all original copyright, trademark, and other proprietary notices and this permission statement; 4. The information contained in this document cannot be used in the development of like products or software, whether for internal or external use, and shall not be used for the benefit of any other party, whether or not for consideration Disclaimer: Information in this publication is subject to change without notice and does not represent a commitment on the part of Cadence. Except as may be explicitly set forth in such agreement, Cadence does not make, and expressly disclaims, any representations or warranties as to the completeness, accuracy or usefulness of the information contained in this document. Cadence does not warrant that use of such information will not infringe any third party rights, nor does Cadence assume any liability for damages or costs of any kind that may result from use of such information. Restricted Rights: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in FAR52.227-14 and DFAR252.227-7013 et seq. or its successor. Installation and Configuration Guide iii Contents 1 About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-1 1.1 Conventions in This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 2 Installing Your Verification Product . . . . . . . . . . . . . . . . . . . . . . . . .2-1 2.1 Understanding the Installation Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 2.2 Installing Your Product with InstallScape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 3 Setting Up the Users Environment . . . . . . . . . . . . . . . . . . . . . . . . .3-1 3.1 Setting Up Products Installed Under VRST_HOME . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 3.1.1 Using the Most Recently Installed Product Versions . . . . . . . . . . . . . . . . . . . . 3-2 3.1.1.1 Version Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 3.1.1.2 Examples for All Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 3.1.2 Using Versions Other than the Most Recently Installed Versions . . . . . . . . . . 3-3 3.1.2.1 Specman Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 3.1.2.2 Enterprise Manager/Design Team Manager and Specman Example 3-5 3.1.3 Using Products in Another Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 3.1.3.1 Enterprise Manager and Specman, Example 1 . . . . . . . . . . . . . . . . . 3-6 3.1.3.2 Enterprise Manager and Specman, Example 2 . . . . . . . . . . . . . . . . . 3-6 3.1.4 Using 64-Bit Specman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 3.1.4.1 64-Bit Examples for All Shells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7 3.2 VRST_HOME/env.[c]sh Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 3.2.1 Environment Variables Set by the $VRST_HOME/env Script . . . . . . . . . . 3-10 3.2.1.1 How the PRODUCT_HOME Variables Are Set . . . . . . . . . . . . . . . 3-10 3.2.2 Shell Commands for Displaying Product Paths . . . . . . . . . . . . . . . . . . . . . . . 3-11 iv Installation and Configuration Guide Contents 4 Debugging Installation and License Errors . . . . . . . . . . . . . . . . . . .4-1 4.1 License Failure Because of System Clock Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 4.2 Removing or Modifying Installations or InstallScape Files . . . . . . . . . . . . . . . . . . . . . . 4-1 5 Configuring Specman and Enterprise Manager . . . . . . . . . . . . . . .5-1 5.1 Compiling eRM or eRM Packages onto the executable . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 5.1.1 Compiling eRM with the Configuration Script . . . . . . . . . . . . . . . . . . . . . . . . 5-2 5.1.2 Compiling eRM and additional eRM Packages with the Configuration Script 5-3 5.1.3 Compiling the Core eRM Package as User Code . . . . . . . . . . . . . . . . . . . . . . 5-3 5.1.4 Loading the Core eRM Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 5.2 Changing Backward Compatibility Settings to Enable the Use of Legacy e Code . . . . 5-4 5.3 Installing Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 5.3.1 Testing a Patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 5.3.2 Installing a Patch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 5.3.3 Uninstalling Patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 5.4 Customizing Settings for Compilation and Linking in the Initialization File . . . . . . . . 5-6 5.5 Linking and Testing Specman with a Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 5.5.1 Linking with the Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 5.5.2 Troubleshooting the Simulator Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 5.6 Installing the License Server and License File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 5.6.1 Updating the FLEXlm License Server with the Script . . . . . . . . . . . . . . . . . . 5-9 5.6.2 Updating the FLEXlm License Server Manually . . . . . . . . . . . . . . . . . . . . . . 5-10 5.7 Running the Configuration Script in Standalone Mode . . . . . . . . . . . . . . . . . . . . . . . . 5-10 6 Specman and Enterprise Manager Initialization Files . . . . . . . . . .6-1 6.1 Customizing the Initialization File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 6.1.1 Manually Editing the First or Third Part of the Initialization File . . . . . . . . . . 6-2 6.1.2 Using the Script to Modify the Second Part of the Initialization File . . . . . . . 6-3 6.1.3 Using a Local File To Override the system.specman Settings . . . . . . . . . . . . . 6-3 6.2 Environment Variables Used with Specman and Enterprise Manager/Design Team Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4 6.2.1 Environment Variables Set in the First Part of the Initialization File . . . . . . . 6-4 6.2.2 License-Related Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 6.2.2.1 Enabling License Request Queuing . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6 6.2.2.2 Enabling Process Suspension and License Release . . . . . . . . . . . . . . 6-7 6.2.2.3 Disabling License Expiration Warnings . . . . . . . . . . . . . . . . . . . . . . 6-7 6.2.3 Additional Environment Variables Used with Specman . . . . . . . . . . . . . . . . . 6-7 Installation and Configuration Guide v Contents 6.2.4 Displaying Environment Variable Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8 7 Using Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-1 7.1 Displaying the HTML Help in your Web Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 7.2 Opening the HTML Help from a GUI Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 7.3 Opening the HTML Help with a Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2 7.4 Copying the HTML Help to Your PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2 7.5 Accessing the Full-Book PDFs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2 Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1 vi Installation and Configuration Guide Contents Installation and Configuration Guide 1-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 1 About This Book This manual describes how to successfully install your verification product with InstallScape, the Cadence download client and installation tool. Installing your verification product is a multi-part process including: Chapter 2 Installing Your Verification Product Chapter 3 Setting Up the Users Environment Specman and Enterprise Manager/Design Team Manager users will find expanded discussions and examples covering product and platform specific install and configuration topics in Chapter 5 Configuring Specman and Enterprise Manager Chapter 6 Specman and Enterprise Manager Initialization Files Additional information and help is available in Chapter 4 Debugging Installation and License Errors Chapter 7 Using Online Help This chapter contains the following section: Conventions in This Book on page 1-1 1.1 Conventions in This Book This manual uses visual cues to help you locate and interpret information easily. These cues are explained in Table 1-1. 1-2 Installation and Configuration Guide About This Book Conventions in This Book 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Table 1-1 Document Conventions Visual Cue Represents courier The Courier font indicates e or HDL code. For example, the following line indicates e code: keep opcode in [ADD, ADDI]; courier bold In examples that show commands and their results, Courier bold indicates the commands. For example, the following line shows the usage of the load command: cmd-prompt> load test1 bold The bold font indicates keywords in descriptive text. For example, the following sentence contains the keyword commands: You can enter multiple -commands arguments. Specman executes the commands in their usage order. italic The italic font represents user-defined variables that you must provide. For example, the following line instructs you to type the write cover as it appears, and then the actual name of a file: write cover filename [ ] square brackets Square brackets indicate optional parameters. For example, in the following construct the keywords list of are optional: var name: [list of] type [ ] bold brackets Bold square brackets are required. For example, in the following construct you must type the bold square brackets as they appear: extend enum-type-name: [name,] construct, An item, followed by a separator (usually a comma or a semicolon) and an ellipsis is an abbreviation for a list of elements of the specified type. For example, the following line means you can type a list of zero or more names separated by commas. extend enum-type-name: [name,] | The | character indicates alternative syntax or parameters. For example, the following line indicates that either the bits or bytes keyword should be used: type scalar-type (bits | bytes: num) Installation and Configuration Guide 1-3 About This Book Conventions in This Book 2006 Cadence Design Systems, Inc. All rights reserved worldwide. % Denotes the UNIX prompt. C1>, C2>, Denotes the simulator prompt (VHDL, Verilog, or mixed -HDL designs). > Denotes a third-party VHDL simulator prompt. cmd-prompt> Denotes the command-line prompt for the tool you are running, including Incisive Enterprise Specman and Incisive Design Team Manager. Table 1-1 Document Conventions (continued) Visual Cue Represents 1-4 Installation and Configuration Guide About This Book Conventions in This Book 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Installation and Configuration Guide 2-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 2 Installing Your Verification Product This chapter describes how to use InstallScape to perform a successful verification product install. InstallScape is a combined download client and installation tool. It downloads, unpacks and installs individual products from Cadence software Releases in a single step. This chapter contains the following sections: Understanding the Installation Hierarchy on page 2-1 Installing Your Product with InstallScape on page 2-2 Note If you run into problems during installation, see Debugging Installation and License Errors on page 4-1 for possible solutions. 2.1 Understanding the Installation Hierarchy The verification products Specman, Enterprise Manager/Design Team Manager, eAnalyzer, and Scenario Builder use a common installation hierarchy and setup procedure. All these productsincluding multiple versions of each productcan be installed under one installation directory. The VRST_HOME environment variable identifies the top installation directory for these products. It might be helpful for you to familiarize yourself with the VRST_HOME installation hierarchy before installing your product. Figure 2-1 illustrates an example VRST_HOME installation hierarchy. In this example are installations of Specman 5.1 and Enterprise Manager 1.4 and 2.0. Notes About the VRST_HOME Installation Hierarchy The verification products are all installed under the /components directory. 2-2 Installation and Configuration Guide Installing Your Verification Product Installing Your Product with InstallScape 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Pre-5.0 versions of Specman cannot be installed under the /components directory. However, you can still use pre-5.0 Specman with Enterprise Manager by identifying the pre-5.0 version with the $VRST_HOME/env script, as described in Using Products in Another Hierarchy on page 3-5. When you install the 64-bit version of Specman, it appears in the same directory as the 32-bit version. As an example, in Figure 2-1, both the 32-bit and the 64-bit Solaris platforms have been installed for Specman 5.1, and both appear in the sn_5.1 directory. Figure 2-1 Example VRST_HOME Installation Hierarchy 2.2 Installing Your Product with InstallScape Follow these steps to install your product with InstallScape: 1. If you are unfamiliar with InstallScape, read about how to use it to install products. Instructions for using InstallScape appear on its web page: http://downloads.cadence.com/ESDGetInstallScape.jhtml. You will need to log in with your SourceLink or eDA-on-Tap login. 2. Download and install InstallScape version 03.40s012 or later. Instructions for downloading and installing InstallScape also appear on its web page: http://downloads.cadence.com/ESDGetInstallScape.jhtml. Tip Version 03.40s012 was posted for downloading on October 25, 2006. Thus, any version posted for downloading after this date is okay to use. /cad/tools/vpa ($VRST_HOME) components (products) sn (symbolic link that points to the Specman version being currently used) sn_5.1 vm (symbolic link that points to the Enterprise Manager/Design Team Manager version being currently used) vm_1.4 vm_2.0 solaris (32-bit) solaris64 (64-bit) ... Installation and Configuration Guide 2-3 Installing Your Verification Product Installing Your Product with InstallScape 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3. Ensure that your preferences are set correctly on http://downloads.cadence.com. See the instructions at the top of http://downloads.cadence.com for how to set your preferences. 4. Download and save the control files for either the Base Release or, if there is one, the most current Update. Tip Both a Base Release and an Update are complete releases. Hotfixes are not complete releases; they must be installed on top of a Base Release or Update. If there is a Hotfix listed for your product, you can also install it, after you install the Base Release or Update. As described in the instructions for using InstallScape, download the control files: a. Click on the product code on http://downloads.cadence.com. The Downloads: Release page appears. b. Click on the Download by InstallScape button for either the Base Release or the most recent Update to download and save the control file. 5. Run InstallScape to install the release in your installation hierarchy. See the instructions on http://downloads.cadence.com/ESDGetInstallScape.jhtml for how to run InstallScape. If you have questions during the installation, get help by clicking on the InstallScape Help button. 6. When the installation is complete, click on Configure in the InstallScape Wizard window. The configuration script appears in a separate window. 7. If the script asks you to select 32-bit or 64-bit configuration, respond appropriately. If you are installing a product that supports 64-bit processing, the script automatically asks whether you want to configure for 32-bit or 64-bit. Once you respond to this prompt, the configuration script banner and main menu appear. 8. Select Complete Configuration from the menu. 9. Follow the prompts to configure your environment. If you need help while performing a complete configuration, see the option descriptions in Chapter 5 Configuring Specman and Enterprise Manager. If you need to reconfigure your product after installation, you can also run the configuration script standalone, as described in Running the Configuration Script in Standalone Mode on page 5-10. See Also Chapter 4 Debugging Installation and License Errors 2-4 Installation and Configuration Guide Installing Your Verification Product Installing Your Product with InstallScape 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Installation and Configuration Guide 3-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3 Setting Up the Users Environment Before starting a verification session, you must perform the following two steps to set up the user environment: 1. Identify the product installation by setting the VRST_HOME variable to point to the topmost installation directory. For example: setenv VRST_HOME /cad/tools/vpa 2. Identify which tool version(s) you want to use by sourcing the $VRST_HOME/env.[c]sh environment script. The environment script identifies the product versions you want to use during that session, and sets the product HOME variables that ensure the correct executables are invoked during the session. For example (when using C shell): source $VRST_HOME/env.csh Step 2 enables the user to use verification products in specified combinations, and products installed in hierarchies other than $VRST_HOME. Multiple versions of the same tool can be installed in the same hierarchy, and you can use tool versions in any supported combination. You can use tools that are installed in different hierarchies. You can pass the path to a specific product version to the env script when you source it. This chapter describes how to perform this two-step procedure. The procedure is described in two sections: Setting Up Products Installed Under VRST_HOME on page 3-2 provides general how-to instructions and examples for using different sets of tool versions together. VRST_HOME/env.[c]sh Reference on page 3-8 provides complete reference information, including: 3-2 Installation and Configuration Guide Setting Up the Users Environment Setting Up Products Installed Under VRST_HOME 2006 Cadence Design Systems, Inc. All rights reserved worldwide. The syntax for passing tool version(s) to the env script. Rules to follow while setting environment variables in a VRST_HOME hierarchy. A description of all the variables set by the env script. A discussion of the appropriate shell command to use to identify executables in a VRST_HOME hierarchy. 3.1 Setting Up Products Installed Under VRST_HOME This section contains examples that illustrate: Using the Most Recently Installed Product Versions on page 3-2 Using Versions Other than the Most Recently Installed Versions on page 3-3 Using Products in Another Hierarchy on page 3-5 Using 64-Bit Specman on page 3-7 3.1.1 Using the Most Recently Installed Product Versions To use the most recently installed versions of all products installed in the current hierarchy, follow these steps: 1. Set VRST_HOME to point to the directory above the /components directory. 2. Execute the $VRST_HOME/env script. The env script sets the $VRST_HOME/components/product_code links to point to the tool versions. By default, the env script sets the product_code links to the most recently installed version. 3.1.1.1 Version Compatibility If you are using verification products together, be sure that the tool/version combinations you initialize work together: If you should be using a version other than the most recently installed version for a given tool, see Using Versions Other than the Most Recently Installed Versions on page 3-3. If you should be using a tool version that is installed in a separate hierarchy, see Using Products in Another Hierarchy on page 3-5. Installation and Configuration Guide 3-3 Setting Up the Users Environment Using Versions Other than the Most Recently Installed Versions 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3.1.1.2 Examples for All Products The following examples each set all product_code links to the most recently installed version, as illustrated in the figure that follows. csh or tcsh Example setenv VRST_HOME /cad/tools/vpa source $VRST_HOME/env.csh sh, bash, or ksh Example VRST_HOME=/cad/tools/vpa export VRST_HOME . $VRST_HOME/env.sh The following figure illustrates a hierarchy with installations of Specman and Enterprise Manager/Design Team Manager. 3.1.2 Using Versions Other than the Most Recently Installed Versions To use product versions installed in the current hierarchy that are not the most recently installed versions, follow these steps: 1. Set VRST_HOME to point to the directory above the /components directory. 2. Execute the $VRST_HOME/env script, passing the relative path(s) for version(s) other than the most recently installed versions. Examples of this type of initialization appear in the following: Specman Example on page 3-4 Enterprise Manager/Design Team Manager and Specman Example on page 3-5 /cad/tools/vpa components sn -> sn_5.1 sn_5.0 sn_5.1 vm_1.4 vm -> vm_2.0 The product code links point to the most recently installed version. vm_2.0 3-4 Installation and Configuration Guide Setting Up the Users Environment Using Versions Other than the Most Recently Installed Versions 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Version Compatibility If you are using verification products together, be sure that the tool/version combinations you initialize work together. See Also VRST_HOME/env.[c]sh Reference on page 3-8 3.1.2.1 Specman Example The following csh commands set the Specman version to 5.0. Other existing toolsfor example, Enterprise Manager, eAnalyzer, or Scenario Builderare set to the most recently installed versions by default, as shown in the figure that follows: Tip Notice that the syntax for csh on Solaris differs from the syntax for csh on Linux. If you use the native sh or csh shell, be sure to check the syntax given in VRST_HOME/env.[c]sh Reference on page 3-8. csh on Linux Example setenv VRST_HOME /cad/tools/vpa source $VRST_HOME/env.csh SPECMAN_HOME=sn_5.0 csh on Solaris Example VRST_HOME=/cad/tools/vpa eval '/bin/sh $VRST_HOME/env.sh -csh SPECMAN_HOME=sn_5.0' The following figure illustrates a hierarchy with installations of Specman and Enterprise Manager/Design Team Manager. /cad/tools/vpa components sn -> sn_5.0 sn_5.0 sn_5.1 The Specman link is set to version 5.0. The Enterprise Manager link is set to the most recently installed version by default. vm_2.0 vm_1.4 vm -> vm_2.0 vm_1.4 Installation and Configuration Guide 3-5 Setting Up the Users Environment Using Products in Another Hierarchy 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3.1.2.2 Enterprise Manager/Design Team Manager and Specman Example The following ksh commands set the Specman version to 5.0 and the Enterprise Manager/Design Team Manager version to 1.4. ksh (any platform) Example VRST_HOME=/cad/tools/vpa export VRST_HOME . $VRST_HOME/env.sh VMANAGER_HOME=vm_1.4 SPECMAN_HOME=sn_5.0 The following figure illustrates a hierarchy with installations of Specman and Enterprise Manager/Design Team Manager: 3.1.3 Using Products in Another Hierarchy To use product versions installed in different hierarchies, follow these steps: 1. Set VRST_HOME to point to the directory above the /components directory. 2. Execute the $VRST_HOME/env script, passing the full path for versions installed in a different hierarchy. In the following examples, Enterprise Manager is installed in a hierarchy separate from Specman: The first example, Enterprise Manager and Specman, Example 1 on page 3-6, shows commands for specifying Enterprise Manager 2.0 with Specman 5.1. The second example, Enterprise Manager and Specman, Example 2 on page 3-6, shows commands for specifying Enterprise Manager 1.4 with Specman 4.3.6. See Also VRST_HOME/env.[c]sh Reference on page 3-8 /cad/tools/vpa components sn -> sn_5.0 sn_5.1 sn_5.0 vm_2.0 vm_1.4 vm -> vm_1.4 The Specman link is set to 5.0 The Enterprise Manager link is set to 1.4. 3-6 Installation and Configuration Guide Setting Up the Users Environment Using Products in Another Hierarchy 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3.1.3.1 Enterprise Manager and Specman, Example 1 The following csh commands set Enterprise Manager 2.0, which is installed under the hierarchy identified by VRST_HOME, to work with Specman 5.1, which is installed in a separate hierarchy, as shown in the figure that follows. csh on Linux Example setenv VRST_HOME /cad/tools/vmanager source $VRST_HOME/env.csh SPECMAN_HOME=/cad/tools/vpa/components/sn_5.1 Because Enterprise Manager 2.0 is the most recently installed version under VRST_HOME, you do not need to enter a path for Enterprise Manager. You do have to enter a full path to Specman 5.1 because it is not in the current VRST_HOME hierarchy. 3.1.3.2 Enterprise Manager and Specman, Example 2 The following csh commands set Enterprise Manager 1.4, which is installed under the hierarchy identified by VRST_HOME, to work with Specman 4.3.6, which is installed in a separate hierarchy, as shown in the figure that follows. csh on Linux Example setenv VRST_HOME /cad/tools/vmanager source $VRST_HOME/env.sh VMANAGER_HOME=vm_1.4 \ SPECMAN_HOME=/cad/tools/specman/sn_rel4.3.6 /cad/tools/vpa components (products) sn -> sn_5.1 sn_5.0 sn_5.1 vm -> vm_2.0 vm_1.4 vm_2.0 /cad/tools/vmanager components (products) The Specman link is set to 5.1. The Enterprise Manager link is set to the most recently installed version, by default. Installation and Configuration Guide 3-7 Setting Up the Users Environment Using 64-Bit Specman 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3.1.4 Using 64-Bit Specman To use 64-bit Specman, follow these steps: 1. Set VRST_HOME to point to the directory above the components directory. 2. Execute the $VRST_HOME/env script, passing the -64-bit option. 3.1.4.1 64-Bit Examples for All Shells The examples in this section show how to set up for using the most recently installed 64-bit version of Specman (that is, no HOME variable paths are passed to the env script). However, you can combine the syntax shown in this section with the syntax shown in the previous sections: Using Versions Other than the Most Recently Installed Versions on page 3-3 Using Products in Another Hierarchy on page 3-5 csh (Linux only) or tcsh Example setenv VRST_HOME /cad/tools/vpa source $VRST_HOME/env.csh -64bit csh (all platforms except Linux) Example setenv VRST_HOME /cad/tools/vpa eval '/bin/sh $VRST_HOME/env.sh -csh -64bit' sh (all platforms except Solaris), bash, or ksh Example VRST_HOME=/cad/tools/vpa export VRST_HOME . $VRST_HOME/env.sh -64bit sh (Solaris) Example VRST_HOME=/cad/tools/vpa export VRST_HOME . $VRST_HOME/env-64bit.sh /cad/tools/specman sn_rel4.3.6 vm -> vm_1.4 vm_1.4 vm_2.0 /cad/tools/vmanager components (products) The Enterprise Manager link is set to vm_1.4 SPECMAN_HOME is set to sn_rel4.3.6. 3-8 Installation and Configuration Guide Setting Up the Users Environment VRST_HOME/env.[c]sh Reference 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3.2 VRST_HOME/env.[c]sh Reference Purpose Set the environment definitions described in Environment Variables Set by the $VRST_HOME/env Script on page 3-10. Syntax 1 tcsh (all platforms) csh (Linux only): source $VRST_HOME/env.csh [-64bit] [PRODUCT_HOME=path-to-install-dir ] Syntax 2 csh (all platforms except Linux): source $VRST_HOME/env.csh eval '/bin/sh $VRST_HOME/env.sh -csh [-64bit] [PRODUCT_HOME=path-to-install-dir ]' Syntax 3 bash and ksh (all platforms) sh (all platforms except Solaris): . $VRST_HOME/env.csh [-64bit] [PRODUCT_HOME=path-to-install-dir ] Syntax 4 sh (Solaris only): . $VRST_HOME/env.sh . $VRST_HOME/env-64bit.sh eval '/bin/sh $VRST_HOME/env.sh -sh [-64bit] [PRODUCT_HOME=path-to-install-dir ]' Installation and Configuration Guide 3-9 Setting Up the Users Environment VRST_HOME/env.[c]sh Reference 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Parameters Description The $VRST_HOME/env script sets variable definitions for all products installed under $VRST_HOME. In particular, the env script sets the HOME variables for all products (EANALYZER_HOME, SBUILDER_HOME, SPECMAN_HOME, VMANAGER_HOME). The HOME variables define the product versions to be used in the current session. You can change product versions at any time by re-sourcing the $VRST_HOME/env script. PRODUCT_HOME The tool HOME environment variable. Following are possible PRODUCT values: SPECMAN VMANAGER EANALYZER SBUILDER By default, all tool HOME variables are set to the most recently installed version of that tool in the current hierarchy. Defining a products HOME variable as PRODUCT_HOME=path-to-install-dir, lets you point to a version other that the most recently installed version of that tool. path-to-install-dir The path to the tool version installation that you want to use: To use a tool installed under $VRST_HOME/components, enter a relative path. For example, to specify Specman 5.1 installed under $VRST_HOME/components, enter: SPECMAN_HOME=sn_5.1 To use a tool installed under a separate hierarchy, enter the full path. For example, to specify Specman 5.0.3 installed under /cad/tools/vpa, enter: SPECMAN_HOME=/cad/tools/vpa/sn_5.0.3 3-10 Installation and Configuration Guide Setting Up the Users Environment Environment Variables Set by the $VRST_HOME/env Script 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Important Do not set any HOME variables separately. Always set HOME variables via the $VRST_HOME/env script. Do not source any of the $PRODUCT_HOME/env scripts (for example, $SPECMAN_HOME/env.csh). These scripts exist only for backwards compatibility for customers whose internal setup is such that they cannot use VRST_HOME. If you source a $PRODUCT_HOME/env script in addition to $VRST_HOME/env.[c]sh, you will introduce setup errors into your environment. You must re-source the $VRST_HOME/env script after installing a new product in the current hierarchy. You cannot run 32-bit vManager 1.1 with 64-bit Specman. (There is no restriction on using versions later than 1.1 with 64-bit Specman.) See Also Environment Variables Set by the $VRST_HOME/env Script on page 3-10 Shell Commands for Displaying Product Paths on page 3-11 Setting Up Products Installed Under VRST_HOME on page 3-2 3.2.1 Environment Variables Set by the $VRST_HOME/env Script The $VRST_HOME/env script sets the following environment variables: SPECMAN_ARCHIdentifies the Specman, Enterprise Manager, or Design Team Manager architecture, for example, solaris or linux. The 64-bit architectures are solaris64 or linux64. PRODUCT_HOME variablesPoints to version hierarchy you want to use for each product. (For details, see How the PRODUCT_HOME Variables Are Set below.) VRST_PATHPoints to product executables. In addition: VRST_HOME/bin is added to your PATH environment variable. 3.2.1.1 How the PRODUCT_HOME Variables Are Set The env script sets the HOME variable for each tool as follows: Installation and Configuration Guide 3-11 Setting Up the Users Environment Shell Commands for Displaying Product Paths 2006 Cadence Design Systems, Inc. All rights reserved worldwide. PRODUCT_HOME = VRST_HOME/components/product_code The product_code is a symbolic link that points to the most recently installed version of the tool by default or, if you pass a HOME path to the env script, to the version you specify. Following is a list of the HOME variables set by the env script: SPECMAN_HOME = VRST_HOME/components/sn VMANAGER_HOME = VRST_HOME/components/vm EANALYZER_HOME = VRST_HOME/components/ea SBUILDER_HOME = VRST_HOME/components/sb See Also Setting Up Products Installed Under VRST_HOME on page 3-2 VRST_HOME/env.[c]sh Reference on page 3-8 3.2.2 Shell Commands for Displaying Product Paths When you use products installed under VRST_HOME, the system keeps track of which executables you are using via links in the $VRST_HOME/bin directory. Because of this, the which shell command always points to $VRST_HOME/bin. For example, the following command: % which specman always returns the following answer, regardless of which Specman version you are currently using: % /path-to-VRST-HOME/bin/specman For example: % /cad/tools/vpa/bin/specman To identify which version you are using of a given product, first use printenv to print the PRODUCT_HOME variable path, instead of which. For example: % printenv SPECMAN_HOME If you are set up to use other than the most recently installed version, it will be explicitly pointed to. % /cad/tools/vpa/components/sn5.1 If you are set up to use the most recently installed version, the symbolic link will be pointed to. % /cad/tools/vpa/components/sn 3-12 Installation and Configuration Guide Setting Up the Users Environment Shell Commands for Displaying Product Paths 2006 Cadence Design Systems, Inc. All rights reserved worldwide. To verify which product version the symbolic link points to, use ls -l to list the target for the symbolic link. For example: % ls -l /cad/tools/vpa/components/sn % sn -> ./sn_5.1 Installation and Configuration Guide 4-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 4 Debugging Installation and License Errors This section describes how to debug errors you may encounter during installation or startup: License Failure Because of System Clock Reset on page 4-1 Removing or Modifying Installations or InstallScape Files on page 4-1 4.1 License Failure Because of System Clock Reset FlexLM checks the dates of the system directories and files (/etc, /var, /tmp and the directories in SPECMAN_HOME) before issuing a license. If any such files have been future dated, Specman issues this error: Specman: Couldn't acquire license - System clock has been set back To solve this problem, correct the timestamp on any future dated files. 4.2 Removing or Modifying Installations or InstallScape Files Do not remove or modify the InstallScape files in the installation directory, such as: .sdx and .sdp files install and installData directories Do not remove an installation by deleting it. Always use the InstallScape Uninstall task to remove an installation. 4-2 Installation and Configuration Guide Debugging Installation and License Errors Removing or Modifying Installations or InstallScape Files 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Do not remove all installations of InstallScape-based releases from an installation directory if it contains installations of non-InstallScape releases, such as Specman 5.0.3 and earlier, or Enterprise Manager 1.4 or earlier. The removal of the last InstallScape-based release results in a complete removal of the installation directory. Installation and Configuration Guide 5-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5 Configuring Specman and Enterprise Manager You must run a configuration script to complete a Specman or Enterprise Manager/Design Team Manager installation. You can run the configuration script as the final step during an InstallScape installation or you can run the configuration script in standalone mode after installation. Running the configuration script is described in: Step 6 through Step 9 in Installing Your Verification Product on page 2-1 Running the Configuration Script in Standalone Mode on page 5-10 The configuration options presented on the main configuration menu are described in: Compiling eRM or eRM Packages onto the executable on page 5-2 Changing Backward Compatibility Settings to Enable the Use of Legacy e Code on page 5-4 Installing Patches on page 5-5 Customizing Settings for Compilation and Linking in the Initialization File on page 5-6 Linking and Testing Specman with a Simulator on page 5-7 Installing the License Server and License File on page 5-8 See Also Chapter 6 Specman and Enterprise Manager Initialization Files 5-2 Installation and Configuration Guide Configuring Specman and Enterprise Manager Compiling eRM or eRM Packages onto the executable 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.1 Compiling eRM or eRM Packages onto the executable This configuration option lets you compile eRM and supplementary eRM packages onto the specman executable so that eRM and its packages are always available for use during your verification sessions. The core eRM package is the evc_util package. Compiling this package onto the executable makes eRM generally available. Supplemental eRM packages are packages like vr_ad, for example. The supplemental eRM packages provided by Cadence (such as vr_ad) are included in the Incisive Plan-to-Closure Methodology release. You must compile the core eRM package onto the executable before you can compile a supplemental eRM packages onto the executable. The following section describes how use the configuration script to compile eRM or a supplemental package onto the executable: Compiling eRM with the Configuration Script on page 5-2 Compiling eRM and additional eRM Packages with the Configuration Script on page 5-3 If you choose not to use the configuration script, you can also access eRM as described in the following section: Compiling the Core eRM Package as User Code on page 5-3 Loading the Core eRM Package on page 5-4 5.1.1 Compiling eRM with the Configuration Script To compile eRM (the evc_util package) with the configuration script: 1. Select the Compile eRM or eRM packages option on the main configuration menu. 2. When prompted, provide the full path to evc_util_top.e. This file appears in the hierarchy as follows: /install-dir-path/components/product/erm_lib/evc_util/e/evc_util_top.e For example: /cad/tools/vpa/components/sn/erm_lib/evc_util/e/evc_util_top.e Installation and Configuration Guide 5-3 Configuring Specman and Enterprise Manager Compiling eRM and additional eRM Packages with the Configuration Script 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.1.2 Compiling eRM and additional eRM Packages with the Configuration Script To compile eRM (the evc_util package) plus additional eRM packages: Note You cannot compile an additional eRM package without also compiling the core eRM package, evc_util. 1. Create an e file that imports the top file for evc_util (evc_util_top.e) and the top file for each of the other packages that you want to compile into Specman. 2. Ensure that SPECMAN_PATH is set so that all eRM packages are visible. If you have installed Incisive Plan-to-Closure Methodology, you can set SPECMAN_PATH by sourcing the following env script: /methodology-install-dir-path/libraries/bin/env.[c]sh For example: %source /cad/tools/vpa/ipcm/libraries/bin/env.csh 3. When configuring the product, select the Compile eRM or eRM packages option. Note If you are doing a complete configuration, this option is automatically presented to you. 4. When prompted by the configuration script, provide the full path to the e file that you created in Step 1. 5.1.3 Compiling the Core eRM Package as User Code If you want to make eRM available for selected runs rather than all runs, you can create a separate executable. To do so, compile evc_util, the core eRM package, onto Specman, rather than installing eRM with the configuration script. To compile evc_util onto Specman: Enter the following command at the shell prompt: % sn_compile.sh -t /tmp evc_util/e/evc_util_top.e This produces an executable with evc_util compiled on top of Specman. The default name is evc_util_top. See Also sn_compile.sh in Specman Command Reference 5-4 Installation and Configuration Guide Configuring Specman and Enterprise Manager Loading the Core eRM Package 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.1.4 Loading the Core eRM Package If you do not install eRM with the configuration script, you can make it available for individual runs by loading evc_util, the core eRM package, onto Specman. To load evc_util: Enter the following command: load evc_util/e/evc_util_top Note You can also load evc_util implicitly if it is imported by another package that you load. 5.2 Changing Backward Compatibility Settings to Enable the Use of Legacy e Code The Specman back33 configuration options let you continue to use code that worked under Specman version 3.3, but that does not work under the current release. This option on the configuration menu lets you set all back33 configuration options except for those that are deprecated with severity ERROR. (Such options are not displayed in the list of back33 options that the installer can modify.) Choose this configuration option to change one or more of the default back33 settings. The prompts presented by the configuration script walk you through your choices. Note If you are installing Enterprise Manager with Specman, you should set the backwards compatibility settings to same values as those set in the Specman version you are using. See Also For details on the 3.3 backwards compatibility options and how to use them, search on 3.3 in the online Specman Help (limit the search to the Specman Doc Set). Managing Deprecation Warning Messages Certain of the back33 configuration options have been deprecated with severity WARNING. If you modify the value these config options, the warning message appears on every Specman invocation by default. You can avoid such warnings for a single session by changing the deprecation severity to IGNORE with the set notify -severity command. You can avoid such warnings for all sessions by creating a patch that contains the set notify -severity=IGNORE command and then installing this patch onto Specman. Installation and Configuration Guide 5-5 Configuring Specman and Enterprise Manager Installing Patches 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.3 Installing Patches Patches are e files containing code that changes the behavior of the executable. Tip Patches are similar to Hotfixes, which you install with InstallScape; however patches are not available on downloads.cadence.com. Your Cadence Application Engineer will let you know whether any patches are required for your environment and also where to get the patches. Choose this configuration option if you want to: Install a patch or patches to change the behavior of an existing executable. Add a non-eRM package to enhance an existing installation. When you install a patch, the system creates a new executable: For Specman, the new executable is $SPECMAN_HOME/platform/specman. For Enterprise Manager, the new executable is $VMANAGER_HOME/platform/emanager. For Design Team Manager, the new executable is $VMANAGER_HOME/platform/dmanager. Note It is not possible to install a patched executable anywhere but in the platform directory or with any name but specman, emanager, or dmanager. This section contains the following: Testing a Patch on page 5-5 Installing a Patch on page 5-5 Uninstalling Patches on page 5-6 5.3.1 Testing a Patch Before installing a patch, test the patch to verify that it solves your problem. To do so, load or compile the patch on top of the executable, as required by the instructions that come with the patch. Then run a simulation to check that the problem is solved. 5.3.2 Installing a Patch 1. Place the patch or non-eRM package file in a directory (for example, /cad/vpa/patches). Note If you want to install multiple patches, create an e file that imports all of the patches, because you can install only one patch file at a time. When the configuration script prompts you for the patch pathname, you can specify the e import file. 2. When configuring the product, select the Install a patch option. 5-6 Installation and Configuration Guide Configuring Specman and Enterprise Manager Uninstalling Patches 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Note If you are doing a complete configuration, this option is automatically presented to you. 3. Follow the instructions given by the script. You will be prompted for the full path to the patch or package file, for example, /cad/vpa/patches/patches_tip.e. When the installation is complete, the new executable is created. 4. Check that all the patches are installed: a. Launch the new executable. b. Enter the show patch command at the command prompt. 5. Relink the new executable with the simulators you use. 5.3.3 Uninstalling Patches You can uninstall all of your patches by installing a null e file as your patch file. Follow the instructions in Installing a Patch to install the null e file. The null file should only contain: <' '> 5.4 Customizing Settings for Compilation and Linking in the Initialization File If you are using VCS or old versions of IUS, you may need to customize your compiling and linking environment. Choose this configuration option if you need to do so. The standard initialization file is $product_home/system.specman, for example $SPECMAN_HOME/system.specman. This configuration option modifies the variable values in this file. See Also If you need help to understand how to customize your compiling and linking environment, see: The chapter Customizing Compiling and Linking in the Specman Elite Integrators Guide The section Customizing Compilation for C Code in the chapter on using the C interface in the Usage and Concepts Guide for e Testbenches For information about the process of customizing the system.specman file, both manually and with the configuration script, see Customizing the Initialization File on page 6-2. Installation and Configuration Guide 5-7 Configuring Specman and Enterprise Manager Linking and Testing Specman with a Simulator 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.5 Linking and Testing Specman with a Simulator You can use this configuration option to link and test Specman with each of the simulators you intend to use. This section contains the following: Linking with the Simulator on page 5-7 Troubleshooting the Simulator Testing on page 5-8 5.5.1 Linking with the Simulator To link and test Specman with a simulator: 1. If you are installing a 64-bit version of Specman, ensure that the GNU GCC compiler is installed. The GCC compiler is the default compiler on Linux. For Sun Solaris, follow the instructions available at http://gcc.gnu.org to install the GNU GCC compiler and configure it to use the GNU Assembler and the Sun native linker (ld). 2. Ensure that you have set your environment for the simulator you are linking to, for example, by setting the necessary environment variables. Note If you are using a 64-bit version of Specman, be sure to link with a 64-bit simulator version. If you link with a 32-bit simulator version, Specman will fail, either at link time or when you try to load the Specman library. 3. When configuring the product, select the Link and Test Specman Elite with a Simulator option. Note If you are doing a complete configuration, this option is automatically presented to you. 4. When prompted, select the compiler you want to use. If you are linking to a 64-bit simulator, you must choose GCC. 5. Select the simulator that you want to link to. In response, Specman creates a statically linked, integrated Specman executable that contains the simulator and stores it in $SPECMAN_HOME/platform. After linking Specman with a simulator, the install script runs the appropriate XOR example in the $SPECMAN_HOME/examples directory to verify that the linking was successful. 5-8 Installation and Configuration Guide Configuring Specman and Enterprise Manager Troubleshooting the Simulator Testing 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.5.2 Troubleshooting the Simulator Testing If the simulator test fails, it is usually due to environment problems. To identify the problem: 1. Set VRST_HOME and source the $VRST_HOME/env script, as described in Chapter 3 Setting Up the Users Environment. 2. Check variable settings (for Specman and the simulator). The following table also lists several error messages that you might encounter and gives suggestions for solving the errors. 5.6 Installing the License Server and License File You can use the configuration script to install the Specman license or update your license server if the license server is already installed: Error Message Possible Cause/Solution Compiler and compiler flags problem: gcc/cc not installed on destination machine 1. Ensure that the correct C compiler is installed. (See C Compilers in Whats New in Specman Elite.) 2. Modify the init file (system.specman) and re-invoke the installer using the link with simulator option. Link with Simulator Failed Cause 1: Native simulator home variable not set correctly. Solution: 1. Set native home variable. 2. Re-invoke installer. 3. Select link Specman with simulator option. Cause 2: Selected simulator version does not match user environment. Look for the link script version in the compilation output. For example: link_xl97B.sh - matches xl 97B Cause 3: Incomplete simulator installation. The simulator should work without Specman before linking it with Specman. Installation and Configuration Guide 5-9 Configuring Specman and Enterprise Manager Updating the FLEXlm License Server with the Script 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Note If LM_LICENSE_FILE is already set to point to your license, you do not need to set SPECMAN_LICENSE_FILE. When you install a new license server, the update shuts down your licenses for a short period. During that time, new invocations of the executable are suspended and other applications that use the same license server may also be affected. The configuration script automatically detects if you need to update the FLEXlm version and also provides you with options for doing so automatically (with the script) or manually. These processes are described in the following sections: Updating the FLEXlm License Server with the Script on page 5-9 Updating the FLEXlm License Server Manually on page 5-10 See Also For more information on FLEXlm licensing tools, see the FLEXlm End Users Guide at http://www.macrovision.com/services/support/flexlm/enduser.pdf. 5.6.1 Updating the FLEXlm License Server with the Script 1. Select Install the license from the configuration script main menu. When you need to update the version of the license server, the script provides you with additional options to do so automatically or manually. 2. Choose menu option 4 Update your license server and tools automatically. After you respond to some license-related prompts, the configuration script shuts down your old license daemon and starts the new one. Then, the configuration script completes the installation process. Note If you do not see options 4 and 5 on the license installation menu and you have not yet upgraded your FLEXlm license daemon to version 9.5, the configuration script failed to detect your current license and therefore assumes that this is a new installation rather than an upgrade. In that case, you must specify your license file by choosing menu option 2) Set SPECMAN_LICENSE_FILE. Thereafter, the configuration script will present the license installation menu with options 4 and 5. 3. Edit your UNIX boot scripts as needed to ensure that they start the new license daemon. You may use the rc.specman script created by the installation for starting the daemon. If necessary, consult your system administrator for assistance. This completes the automatic update process. 5-10 Installation and Configuration Guide Configuring Specman and Enterprise Manager Updating the FLEXlm License Server Manually 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 5.6.2 Updating the FLEXlm License Server Manually If you choose not to upgrade automatically, you must start the new license daemon manually. 1. If you are running the configuration script, select option 5 Pause installation to update your license server and tools manually from the license menu. 2. On a UNIX terminal, shut down your old license server with the command: lmdown -c your_license_file 3. Update your license server to the version found in $VRST_HOME/components/sn/license/platform or $VRST_HOME/components/vm/license/platform. If necessary, consult your system administrator for assistance. 4. Start the new daemon with the command: lmgrd -c your_license_file Verify that the started verisityd is version 9.5. 5. Return to the installation terminal and press Enter to resume the installation process. 6. Edit your UNIX boot scripts as needed to ensure that they start the new license daemon. If necessary, consult your system administrator for assistance. This completes the manual update process. 5.7 Running the Configuration Script in Standalone Mode You can run the configuration script as part of an InstallScape installation (as described in Installing Your Verification Product on page 2-1), or you can run it in standalone mode, after installation. The configuration script appears in the installation hierarchy in: $VRST_HOME/components/sn/bin/configure_specman.sh $VRST_HOME/components/vm/bin/configure_vmanager.sh To run the configuration script: 1. Set the environment variable VRST_HOME to the topmost installation directory (the parent directory for components). 2. Source the $VRST_HOME/env.[c]sh script appropriately. See VRST_HOME/env.[c]sh Reference on page 3-8 for reference. Installation and Configuration Guide 5-11 Configuring Specman and Enterprise Manager Running the Configuration Script in Standalone Mode 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 3. Start the configuration script. If you are configuring a 64-bit installation, enter the -64bit option with the configuration script. Examples: % sh $VRST_HOME/components/sn_5.1/bin/configure_specman.sh % sh $VRST_HOME/components/sn_5.1/bin/configure_specman.sh -64bit 4. Enter the number of the desired configuration option. Then follow the on-screen instructions, providing appropriate answers to questions. See Also The prompts on the configuration script are described in the following sections: Compiling eRM or eRM Packages onto the executable on page 5-2 Changing Backward Compatibility Settings to Enable the Use of Legacy e Code on page 5-4 Installing Patches on page 5-5 Customizing Settings for Compilation and Linking in the Initialization File on page 5-6 Linking and Testing Specman with a Simulator on page 5-7 Installing the License Server and License File on page 5-8 5-12 Installation and Configuration Guide Configuring Specman and Enterprise Manager Running the Configuration Script in Standalone Mode 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Installation and Configuration Guide 6-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 6 Specman and Enterprise Manager Initialization Files The system.specman initialization file contains variables that control compilation, linking, and some runtime capabilities. These variables, which are set by the configuration script and are used by the sn_compile.sh script, define: Which C compiler is used and which flags are passed to it Which linker is used and which flags are passed to it Which link script is used to link the simulator with Specman Which version of the simulation interface file (pli.tab, veriuser.c, spdtbl.c, or cfctable.c, and so on) is used to link simulation tools to Specman Where to find the object files and libraries used to link simulation tools to Specman Whether to enable license queueing at runtime Whether to turn off license expiration warnings This chapter describes the initialization file used by Specman and Enterprise Manager/Design Team Manager, and how to edit the file. It also describes the basic environment variables used for Specman and Enterprise Manager/Design Team Manager. This chapter contains the following sections: Customizing the Initialization File on page 6-2 Environment Variables Used with Specman and Enterprise Manager/Design Team Manager on page 6-4 6-2 Installation and Configuration Guide Specman and Enterprise Manager Initialization Files Customizing the Initialization File 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 6.1 Customizing the Initialization File The standard initialization file is $PRODUCT_HOME/system.specman, for example $SPECMAN_HOME/system.specman. This file is modified automatically during installation, based on the choices you make during the configuration phase of the installation. The system.specman initialization file is split into three parts: Part 1Defines machine independent variables. You can change this part manually only. Environment Variables Used with Specman and Enterprise Manager/Design Team Manager on page 6-4 describes the environment variables in the first part of the init file. Part 2Defines machine dependent variables, such as compilation variables, as well as the scripts, libraries, and simulation interface files used to link Specman with a simulator. You can set these variables only with the configuration script. Part 3Defines other setup routines. For example, it contains code that enables the use of 32-bit Specman on 64-bit machines. This part can also be manually edited. This section describes the following: Manually Editing the First or Third Part of the Initialization File on page 6-2 Using the Script to Modify the Second Part of the Initialization File on page 6-3 Using a Local File To Override the system.specman Settings on page 6-3 6.1.1 Manually Editing the First or Third Part of the Initialization File You can manually edit only the first or third part of the initialization file. See Environment Variables Used with Specman and Enterprise Manager/Design Team Manager on page 6-4 for a description of the environment variables that appear in the first part of the initialization file. Note When changing the first part of the initialization file or when creating a local .specman file, you must use standard Bourne shell syntax. In particular this means that white spaces are not allowed in assignments. This is valid: LICENSE_QUEUEING=yes This is not valid: LICENSE_QUEUEING = yes Installation and Configuration Guide 6-3 Specman and Enterprise Manager Initialization Files Using the Script to Modify the Second Part of the Initialization File 2006 Cadence Design Systems, Inc. All rights reserved worldwide. See UNIX man pages for sh for more information. 6.1.2 Using the Script to Modify the Second Part of the Initialization File If you are using VCS or old versions of IUS, you may need to customize your compiling and linking environment. This environment is defined in the second part of the initialization file. You must use the install script to modify the second part of the initialization file. Any manual editing in the second part can cause errors during automatic updates of the initialization file. To modify the second part of the initialization file: 1. Start the install script (see Running the Configuration Script in Standalone Mode on page 5-10) and select option 4, Customize initialization. 2. Respond to the prompts appropriately. See Also If you need help to understand how to customize your compiling and linking environment, see: The chapter Customizing Compiling and Linking in the Specman Elite Integrators Guide The section Customizing Compilation for C Code in the chapter on using the C interface in the Usage and Concepts Guide for e Testbenches 6.1.3 Using a Local File To Override the system.specman Settings You can override the settings in the system.specman initialization file by placing a local .specman file in the $PRODUCT_HOME directory or in the current directory. Use this local .specman file to change default environment variable settings or add new settings, for your personal use. Note Cadence recommends that you define only those entries you would like to change or add in a local .specman file. On invocation, the system searches for initialization files in the following order: 1. $PRODUCT_HOME/system.specman 2. .specman file in the $HOME directory ($HOME/.specman) Settings in this file override the settings in $PRODUCT_HOME/system.specman. 3. .specman file in the current directory (./.specman) 6-4 Installation and Configuration Guide Specman and Enterprise Manager Initialization Files Environment Variables Used with Specman and Enterprise Manager/Design Team Manager 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Settings in this file override the settings in all other initialization files. Notes In some cases, you can also override or add to the .specman settings by using options to the sn_compile.sh or vm_compile.sh script. Keep in mind that you must use standard Bourne shell syntax when editing your .specman file. In particular this means that white spaces are not allowed in assignments. This is valid: LICENSE_QUEUEING=yes This is not valid: LICENSE_QUEUEING = yes 6.2 Environment Variables Used with Specman and Enterprise Manager/Design Team Manager This section contains the following information: Environment Variables Set in the First Part of the Initialization File on page 6-4 License-Related Environment Variables on page 6-6 Additional Environment Variables Used with Specman on page 6-7 Displaying Environment Variable Values on page 6-8 6.2.1 Environment Variables Set in the First Part of the Initialization File Table 6-1 describes the environment variables in the first part of the initialization file that you might encounter while using your product, or whose value you might want to edit. As described in Customizing the Initialization File on page 6-2, you can edit the first part of the initialization file manually. The second part of the initialization file contains environment variables that you must set with the configuration script (you must not set these environment variables manually). Chapter 5 Configuring Specman and Enterprise Manager describes the options available with the configuration script. Installation and Configuration Guide 6-5 Specman and Enterprise Manager Initialization Files Environment Variables Set in the First Part of the Initialization File 2006 Cadence Design Systems, Inc. All rights reserved worldwide. Table 6-1 Environment Variables Set in the First Part of the Initialization File Variable Use and Default Setting VRST_APPLICATION_HOME Set to PRODUCT_HOME during installation. Do not change this value. SPECMAN_ARCH The value set by $VRST_APPLICATION_HOME/bin/sn_arch.sh. Do not change this value. SPECMAN_DIR The directory indicated by $VRST_APPLICATION_HOME/$SPECMAN_ARCH. Do not change this value. SPECMAN_PATH The search path for a file to be read by Specman. The default is: ":$SPECMAN_DIR :$VRST_APPLICATION_HOME/src :$VRST_APPLICATION_HOME/docs :$VRST_APPLICATION_HOME/tcl/specman :$VRST_APPLICATION_HOME/erm_lib :$VRST_APPLICATION_HOME/svm_lib :$SPECMAN_PATH" SPECMAN_TCL_LIBRARY Defines the location of library files for the GUI. The default is $VRST_APPLICATION_HOME/tcl/tcl/library. SPECMAN_TIX_LIBRARY Defines the location of library files for the GUI. The default is $VRST_APPLICATION_HOME/tcl/tix/library. SPECMAN_TK_LIBRARY Defines the location of library files for the GUI. The default is $VRST_APPLICATION_HOME/tcl/tk/library. SPECMAN_PRE_COMMANDS Defines Specman commands to be executed before any other commands. See Passing Commands with $SPECMAN_PRE_COMMANDS in the Specman Elite Integrators Guide for more information. SPECMAN_AUTO_PRE_ COMMANDS Specifies whether Specman precommands are executed automatically or not. The default is TRUE, meaning that precommands are executed automatically. See Troubleshooting the Use of Precommands in the Specman Elite Integrators Guide for more information. 6-6 Installation and Configuration Guide Specman and Enterprise Manager Initialization Files License-Related Environment Variables 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 6.2.2 License-Related Environment Variables There are several license-related environment variables, only one of which is in the first section of the initialization file. You can set these variables manually for your environment, as described in the following sections: Enabling License Request Queuing on page 6-6 Enabling Process Suspension and License Release on page 6-7 Disabling License Expiration Warnings on page 6-7 6.2.2.1 Enabling License Request Queuing By default, the software exits if no license is available. To enable license queueing, you must add the following line to your .specman initialization file before invoking Specman, Enterprise Manager, or Design Team Manager: LICENSE_QUEUEING=yes SPECMAN_EDITOR Defines the editor used by the Specman edit command. See edit in the Specman Command Reference for more information. SPECMAN_PAGER Defines the pager used by the Specman type command. See type in the Specman Command Reference for more information. SPECMAN_TEMP_DIR Defines a temporary directory used to store internal files. See new_temp_file() in the e Language Reference. LICENSE_QUEUEING Enables waiting for a free license. The default is that the system exits if there is no free license. See Enabling License Request Queuing on page 6-6 for more information. Table 6-1 Environment Variables Set in the First Part of the Initialization File Variable Use and Default Setting Installation and Configuration Guide 6-7 Specman and Enterprise Manager Initialization Files Additional Environment Variables Used with Specman 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 6.2.2.2 Enabling Process Suspension and License Release By setting an environment variable that enables process suspension, you can suspend your current session at any time and return the license to the pool. No special license feature is required to do this. 1. Add the following to the system.specman file (or a local copy of .specman) or define as an environment variable: SN_ENABLE_LICENSE_RELEASE=yes 2. To suspend the current session, enter suspend at the command prompt. The current session is suspended. 3. To resume the process, press the Return key The session is resumed. 6.2.2.3 Disabling License Expiration Warnings You can turn off license expiration warnings by adding the following line to your .specman initialization file: DISABLE_EXPIRATION_WARNING=yes 6.2.3 Additional Environment Variables Used with Specman This section describes additional UNIX environment variables used within Specman. None of these variables are given a default setting by Specman. To make your settings for these environment variables permanent, add them to your local .specman file. (See Using a Local File To Override the system.specman Settings on page 6-3.) SPECMAN_WEB_BROWSER: This environment variable specifies the external web browser that Specman uses to open the online Help, the Support button GUI, or other windows opened with a browser. If you do not set this environment variable, Specman attempts to open Netscape as the external web browser. SPECMAN_MAIN_CCOMPILER: When integrating C++ code with standalone Specman, you may need to compile the Specman main() function using the same C++ compiler that compiled your C++ code. (You can consult your C++ compiler documentation and linker documentation to see if this is a requirement.) To choose a compiler for the main() function of standalone Specman, you can set SPECMAN_MAIN_CCOMPILER to point to your C++ compiler. For more information, search on SPECMAN_MAIN_CCOMPILER in the Specman online Help. 6-8 Installation and Configuration Guide Specman and Enterprise Manager Initialization Files Displaying Environment Variable Values 2006 Cadence Design Systems, Inc. All rights reserved worldwide. SPECMAN_CVL_CONNECTION_NAME, SPECMAN_CVL_SERVER_HOST, SPECMAN_CVL_SERVER_PORT, SPECMAN_CVL_TRACE, and SPECMAN_CVL_CONNECTION_NAME: These environment variables are used with CVL (the Specman Co-Verification Link). For information about these variables, search on the relevant environment variable name in the Specman online Help. 6.2.4 Displaying Environment Variable Values You can display the values for current environment variables: From within Specman, use the show ini setting command. This command displays the UNIX environment variable settings in all your current initialization (.specman) files. For information on this variable, search for show ini setting in the online Specman doc set or show ini setting in the Specman Command Reference. From within e code, use the get_symbol() routine. This routine returns the value of any given UNIX environment variable. For information on this variable, search for get_symbol in the Specman doc set or get_symbol in the e Language Reference. Installation and Configuration Guide 7-1 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 7 Using Online Help Whenever you need additional help using your product, open the online Help or full-book PDF files for reference. This chapter describes the various ways in which you can access Help. Displaying the HTML Help in your Web Browser on page 7-1 Opening the HTML Help from a GUI Window on page 7-1 Opening the HTML Help with a Script on page 7-2 Copying the HTML Help to Your PC on page 7-2 Accessing the Full-Book PDFs on page 7-2 7.1 Displaying the HTML Help in your Web Browser To display the online Help: 1. In your web browser, open install-dir/docs/VerisityHelp.htm. A menu of Verification products appears. 2. Click on the link for the product you just installed. The online Help for your product appears. 3. Bookmark this page for future reference. 7.2 Opening the HTML Help from a GUI Window To display the online HTML Help from a product GUI window Select from the Help menu or click on a Help button. 7-2 Installation and Configuration Guide Using Online Help Opening the HTML Help with a Script 2006 Cadence Design Systems, Inc. All rights reserved worldwide. 7.3 Opening the HTML Help with a Script To display the online Specman or Enterprise Manager/Design Team Manager HTML Help using a script: SpecmanExecute the $VRST_HOME/components/sn/bin/sn_help.sh script. Enterprise Manager/Design Team ManagerExecute the $VRST_HOME/components/vm/bin/vm_help.sh script. Note The eAnalyzer and Scenario Builder installs do not create scripts for displaying their online HTML Help. 7.4 Copying the HTML Help to Your PC To copy and use the online Help in another location, such as your PC: 1. Copy the $VRST_HOME/components/product/docs/online_help directory to your desired location. 2. On your PC, open the VerisityHelp.htm file that appears in the /online_help directory. Specman example: /cad/tools/vpa/components/sn_6.0/docs/online_help/VerisityHelp.htm 3. Bookmark this page for future reference. 7.5 Accessing the Full-Book PDFs To access full-book PDFs of the documentation set: 1. Change directories to $VRST_HOME/components/product/docs/pdf_docs. Example: /cad/tools/vpa/components/sn_5.1/docs/pdf_docs /cad/tools/vpa/components/vm_2.0/docs/pdf_docs 2. Open the PDF document that you want to read. Note As long as you keep a products PDF files together in the same sub-directory, the links between the products PDF files will work. Installation and Configuration Guide Index-1 Index Symbols $DISABLE_EXPIRATION_WARNING 6-7 $EANALYZER_HOME variable how set 3-10 $LICENSE_QUEUEING 6-6 $LM_LICENSE_FILE 5-8 $SBUILDER_HOME variable how set 3-10 $SN_ENABILE_LICENSE_RELEASE 6-7 $SPECMAN_ARCH 6-5 $SPECMAN_ARCH, setting 3-10 $SPECMAN_AUTO_PRE_COMMANDS 6-5 $SPECMAN_DIR 6-5 $SPECMAN_EDITOR 6-6 $SPECMAN_HOME setting 3-10 $SPECMAN_HOME environment variable how set 3-10 $SPECMAN_LICENSE_FILE 5-8 $SPECMAN_PAGER 6-6 $SPECMAN_PATH 6-5 $SPECMAN_PRE_COMMANDS 6-5 $SPECMAN_TCL_LIBRARY 6-5 $SPECMAN_TEMP_DIR 6-6 $SPECMAN_TIX_LIBRARY 6-5 $SPECMAN_TK_LIBRARY 6-5 $VMANAGER_HOME environment variable how set 3-10 $VRST_APPLICATION_HOME 6-5 $VRST_PATH, setting 3-10 Numerics 64-bit Specman preparing to use 3-7 B back33 options setting with configuration script 5-4 backward compatibility 3.3 settings 5-4 C env. 3-1, 3-8, 3-10 files env. 3-8, 3-10 scripts env. 3-1 configuration backward compatibility, setting 5-4 eRM, installing 5-2 patches, installing 5-5 simulators, linking 5-7 Specman testing 5-8 Index-2 Installation and Configuration Guide Index D DISABLE_EXPIRATION_WARNING 6-7 documentation conventions 1-1 E EANALYZER_HOME variable how set 3-10 environment variables $SPECMAN_EDITOR 6-6 $SPECMAN_HOME how set 3-10 $VMANAGER_HOME how set 3-10 DISABLE_EXPIRATION_WARNING 6-7 displaying value of 6-8 EANALYZER_HOME how set 3-10 LICENSE_QUEUEING 6-6 SBUILDER_HOME how set 3-10 SN_ENABLE_LICENSE_RELEASE 6-7 SPECMAN_ARCH 3-10, 6-5 SPECMAN_AUTO_PRE_COMMANDS 6-5 SPECMAN_DIR 6-5 SPECMAN_HOME 3-10 SPECMAN_LICENSE_FILE 5-8 SPECMAN_PAGER 6-6 SPECMAN_PATH 6-5 SPECMAN_PRE_COMMANDS 6-5 SPECMAN_TCL_LIBRARY 6-5 SPECMAN_TEMP_DIR 6-6 SPECMAN_TIX_LIBRARY 6-5 SPECMAN_TK_LIBRARY 6-5 VRST_APPLICATION_HOME 6-5 VRST_PATH 3-10 eRM installing 5-2 evc_util compiling on top of Specman 5-3 loading on top of Specman 5-4 evc_util package installing 5-2 F files .specman 6-2 init 6-2 sdp 4-1 sdx 4-1 system.specman 6-2 FlexLM failure due to file timestamp 4-1 FLEXlm license server 5-8 G GCC compiler for 64-bit Specman 5-7 I initialization file customizing 6-2 initialization files 6-2 set up by configure_specman.sh script 6-1 used by sn_compile.sh script 6-1 installation finalizing 3-1 initialization file customizing 6-2 license server, installing 5-8 preparing to use 3-1 setup examples 3-2 installations deleting 4-1 InstallScape deleting files 4-1 L license expiration warnings, disabling 6-7 file, setting 5-8 Installation and Configuration Guide Index-3 Index installing server 5-8 queue 6-6 waiting for 6-6 license expiration warnings disabling 6-7 license server installing 5-8 LICENSE_QUEUEING 6-6 licenses failure due to file timestamp 4-1 releasing 6-7 LM_LICENSE_FILE 5-8 P patches installing 5-5 specman executable 5-5 process suspension 6-7 Q queuing waiting for a license 6-6 S SBUILDER_HOME variable how set 3-10 .sdp files 4-1 .sdx files 4-1 sh 3-1, 3-8, 3-10 sh file 3-8, 3-10 sh script 3-1 simulators linking with Specman 5-7 SN_ENABLE_LICENSE_RELEASE 6-7 Specman initialization files 6-2 installation removing 4-1 linking with simulator 5-7 suspension of 6-7 specman executable 5-5 Specman Simulator documentation, installing 5-7 SPECMAN_ARCH 6-5 SPECMAN_ARCH, setting 3-10 SPECMAN_AUTO_PRE_COMMANDS 6-5 SPECMAN_DIR 6-5 SPECMAN_EDITOR 6-6 SPECMAN_HOME setting 3-10 SPECMAN_HOME environment variable how set 3-10 SPECMAN_LICENSE_FILE 5-8 SPECMAN_PAGER 6-6 SPECMAN_PATH 6-5 SPECMAN_PRE_COMMANDS 6-5 SPECMAN_TCL_LIBRARY 6-5 SPECMAN_TEMP_DIR 6-6 SPECMAN_TIX_LIBRARY 6-5 SPECMAN_TK_LIBRARY 6-5 system.specman file 6-2 V VMANAGER_HOME environment variable how set 3-10 VRST_APPLICATION_HOME 6-5 VRST_PATH, setting 3-10 Index-4 Installation and Configuration Guide Index