NAG Library for the Xeon Phi Coprocessor, Mark 23

FSLM623DCL - License Managed

Linux 64 (Intel 64 and MIC), Intel Fortran, Double Precision

Installer's Note



Contents


1. Introduction

This Installer's Note is essential reading for whoever is responsible for the installation of this implementation of the NAG Library for the Xeon Phi Coprocessor. It is available together with the Users' Note (un.html) on the distribution medium.

Your attention is drawn to the terms and conditions of the Software License regarding the use of NAG software. Requests for information about the availability of other implementations must be referred to NAG.

2. Implementation Provided

2.1. Applicability

This implementation is a compiled, tested, ready-to-use version of the NAG Library for the Xeon Phi Coprocessor that is considered suitable for operation on the computer systems detailed below:

Hardware:          Genuine Intel ® x86_64 with MIC coprocessor
Operating System:  Linux 2.6.32-220.el6.x86_64 with glibc-2.12-1.47.el6.x86_64
(Red Hat Enterprise Linux Server release 6.2 (Santiago)) Fortran Compiler: Intel Fortran Intel 64 Compiler
version 13.1.1.163 20130313 Vendor Library: Intel MKL version MIC Update 2 11.0.3.163 Compiler options: -msse3 -axavx -mp1 -fpp -fPIC -auto -implicitnone -align array64byte -openmp Driver Version: 5889-16 MPSS Version: 2.1.5889-16

2.2. Derivation

This implementation was produced at NAG Ltd., Oxford on the computing system detailed below:

Hardware:          Genuine Intel ® x86_64 with MIC coprocessor
Operating System:  Linux 2.6.32-220.el6.x86_64 with glibc-2.12-1.47.el6.x86_64
(Red Hat Enterprise Linux Server release 6.2 (Santiago)) Fortran Compiler: Intel Fortran Intel 64 Compiler
version 13.1.1.163 20130313 Vendor Library: Intel MKL version MIC Update 2 11.0.3.163 Compiler options: -msse3 -axavx -mp1 -fpp -fPIC -auto -implicitnone -align array64byte -openmp Driver Version: 5889-16 MPSS Version: 2.1.5889-16 MIC Flash Version: 2.1.01.0385 MIC SMC Boot Loader Version: 1.8.4326 MIC uOS Version: 2.6.38.8-g9b2c036

This implementation has been tested at NAG Ltd., Oxford using the two compilers listed below:

Fortran compiler: Intel ® Fortran Intel ® 64 Compiler XE
                  for applications running on Intel ® 64,
                  Version 13.1.0.146 Build 20130121
and
Fortran compiler: Intel ® Fortran Intel ® 64 Compiler XE
                  for applications running on Intel ® 64,
                  Version 13.1.2.183 Build 20130514

Each routine in the NAG Library for the Xeon Phi Coprocessor, Mark 23, was compiled with the highest level of optimization that enabled the functionality provided by the library to be verified and validated. Most routines in the library were compiled with the optimization flag -O3 ; some routines will have been compiled with a lower level of optimization when necessary.

In this implementation:

The library has been tested with MKL version 11.0.3.163, and this version of MKL is supplied as a part of this product (see contents). Please see the Intel web site for further information about MKL (http://www.intel.com/software/products/mkl).

2.3. Post Release Information

Please check the following URL:

http://www.nag.co.uk/doc/inun/fs23/lm6dcl/postrelease.html

for details of any new information related to the applicability or usage of this implementation.

3. Distribution Medium

The software is available to download from any of the NAG websites (see NAG Websites under Section 5). Upon request, the software may be distributed by CD or DVD as appropriate.

3.1. Contents

The following shows the directory/file organization of the implementation materials as they will be installed.
            |- doc -|- in.html  (Installer's Note, (this document))
            |       |- un.html  (Users' Note)
            |
            |       |- intel64 -|- libnagsmp.a  (static library requiring
            |       |           |                vendor BLAS/LAPACK)
            |       |           |- libnagsmp.so (shareable library requiring
            |       |           |                 vendor BLAS/LAPACK)
            |       |           |- libnagsmpMIC.a (companion static library for 
            |       |           |                  heterogeneous linking)
            |       |           |- libnag_performance_parameters.a 
            |       |           |                  (static library for heterogeneous
            |       |           |                   linking - offload control)
            |       |           |- libnag_performance_parametersMIC.a 
            |       |           |                  (companion static library for 
            |       |           |                   heterogeneous linking - offload
            |- lib -|           |                   control)
            |       |           |- libnag_performance_parameters_sb1.a 
            |       |           |                  (static library for heterogeneous
            |       |           |                   linking - offload control based
            |       |           |                   on 1 Sandybridge Xeon host (same as sb1))
            |       |           |- libnag_performance_parameters_sb1MIC.a 
            |       |           |                  (companion static library for 
            |       |           |                   heterogeneous linking - offload
            |       |           |                   control based on 1 Sandybridge
            |       |           |                   host)
            |       |           |- libnag_performance_parameters_sb2.a 
            |       |           |                  (static library for heterogeneous
            |       |           |                   linking - offload control based
            |       |           |                   on 2 Sandybridge Xeon hosts)
            |       |           |- libnag_performance_parameters_sb2MIC.a 
            |       |           |                  (companion static library for 
            |       |           |                   heterogeneous linking - offload
            |       |           |                   control based on 2 Sandybridge
            |       |           |                   hosts)
            |       |           |- libnag_performance_parameters.so
            |       |           |                  (shareable library for heterogeneous
            |       |           |                   linking - offload control)
            |       |           |- libnag_performance_parameters_sb1.so
            |       |           |                  (shareable library for heterogeneous
            |       |           |                   linking - offload control based
            |       |           |                   on 1 Sandybridge Xeon host (same as sb1))
            |       |           |- libnag_performance_parameters_sb2.so
            |       |                              (shareable library for heterogeneous
            |       |                               linking - offload control based
            |       |                               on 2 Sandybridge Xeon hosts)
            |       |        
            |       |- mic -|- libnagsmp.a  (static library requiring
            |               |                vendor BLAS/LAPACK - native)
            |               |- libnagsmp.so (shareable library requiring
            |                                vendor BLAS/LAPACK - native)
fslm623dcl -|
            |- nag_interface_blocks -|- *
            |
            |            |- source --|- ??????e.f90
            |            |
            |- examples -|- data ----|- ??????e.d
            |            |           |- ??????e.opt
            |            |
            |            |- results -|- ??????e.r
            |
            |- scripts -|- nagsmp_example
            |           |- nagsmp_example_shar
            |           |- nagsmp_example_native
            |           |- nagsmp_example_shar_native
            |
            |- mkl -|- lib -|- intel64  (Intel Math Kernel Libraries for host)
            |               |
            |               |- mic      (Intel Math Kernel libraries for Xeon Phi)
            |
            |- rtl -|- intel64  (Compiler run-time libraries for host)
            |       |
            |       |- mic      (Compiler run-time libraries for Xeon Phi)
            |
            |- license -|- README.TXT
                        |
                        |- doc -|- * (End User Guide)
                        |
                        |- bin -|- * Licence management binaries

The following shows the directory/file organization of the Library Manual materials as they will be installed.

nagdoc_Intel_MIC_FS23.3 -|- index.html
                         |
                         |- examples -|- baseresults -|- ??????*.r
                         |            |- source      -|- ??????*.f90
                         |            |- data        -|- ??????*.d
                         |                            |- ??????*.opt
                         |- xhtml -|- FRONTMATTER -|- manconts.xml  (main XHTML index)
                                   |               |- *.xml         (foreword & copyright)
                                   |
                                   |- [A00-X05] -|- *conts.xml  (chapter contents)
                                   |
                                   |- figures -|- *.png  (figures and plotfiles)
                                   |
                                   |- GENINT -|- *.xml  (general introductory material)
                                   |
                                   |- INDEXES -|- GAMS -|- gams.xml  (GAMS index)
                                   |           |        |- *.xml     (GAMS files)
                                   |           |
                                   |           |- KWIC -|- kwic.xml  (KWIC index)
                                   |                    |- *.xml     (KWIC files)
                                   |
                                   |- styles -|- libdoc.css      (main CSS stylesheet)
                                              |- nagmathml.css   (MathML stylesheets)
                                              |- pmathml.css

3.2. File Sizes

The files require approximately the following disk space:
  Library software:  1.5 GB
  Library Manual:    94 MB

4. Installation

4.1. Installation of Library Software and Manual

If you have been given the Library materials as a tar gzip file (fslm623dcl.tgz), cd to the directory where the file is located and extract the installation materials using the following commands:
  gunzip fslm623dcl.tgz
  tar xvf fslm623dcl.tar
This will extract the files install.sh, fs23.tar, lic_agr.txt, in.html and un.html.

If you have downloaded the Library Manual as a tar gzip file (mk23_xeon_phi_doc.tgz) run the command

  gunzip mk23_xeon_phi_doc.tgz
to extract the file mk23_xeon_phi_doc.tar.

4.1.1. Installation Procedure

You can install the materials from the CD/DVD or download directory by executing the Bourne Shell script install in a command window as:
  ./install.sh
If you are logged in as root then by default, the materials will be installed in /opt/NAG/ or /usr/local/NAG/ depending on your system. However, you may choose a different location. In this document we refer to the directory /opt/NAG/fslm623dcl or /usr/local/NAG/fslm623dcl as [INSTALL_DIR]. This convention is also used in the Users' Note (un.html).

The directory [INSTALL_DIR]/scripts contains scripts to show how to use the pre-compiled modules and the libraries provided with this implementation. See Users' Note, Section 3.3. Subsequent to the installation, if you move this product to some other location then these scripts must be changed to reflect that fact.

The install script can install the Library Manual in the same location as the NAG Library material or at some other location of your choice.

You may wish to move the Library Manual to the same location as that for other NAG products. You are encouraged to make it readily available to users.

4.1.2. License Management

The use of the NAG Library for the Xeon Phi Coprocessor is controlled by the Kusari license management system. This release of the NAG Library for the Xeon Phi Coprocessor uses version 2.2-58 of Kusari.

In order to enable the software, NAG will issue you with two license keys. The license keys are contained in a text file consisting of details of the software that will be enabled.

To request the license keys, run the program khostid located in the license/bin/linux_x64/ subdirectory of the software distribution. This utility must be run from a command prompt on the host. Then run khostid located in the license/bin/mic/ subdirectory of the software distribution. This utility must be run from a command prompt on the Xeon Phi, for example as follows: ssh mic0 "[INSTALL_DIR]/license/bin/mic/khostid". Return the information that is displayed by both of these programs, together with the product code (in this case FSLM623DCL), by e-mail (or FAX) to NAG. Alternatively, direct the output from this utility to a file and send both the file and the product code to NAG.

Short term (demonstration or trial) license keys contain one or more lines like the following:

FSLM623DC TRIAL 2013/09/05 "Enl9Eh4SpMfmBIdUfnQFgicnFY"
Specifically, there is a line containing the word TRIAL. Longer term license keys must be locked to a specific computer, i.e. they will enable the software on one computer only. These license keys include the word NODE instead of the word TRIAL above.

Once you have obtained the required license keys, the easiest way to install it is to store the text in a file,

  /opt/NAG/nag.key
or
  /usr/local/NAG/nag.key
The license software in this implementation automatically looks for these particular files and reads the first one found, so no other action is necessary. Alternatively, store the license in a file with a name and location of your choice, say,
  [INSTALL_DIR]/license.lic.
Note that, in order to allow license validation from within an offloaded region running on the Xeon Phi, it is necessary that the license key is in a location that is readable by "all" in the system and mounted on the Xeon Phi coprocessor. The location must be readable by "all" because offloaded regions running on the Xeon Phi are executed as a special user called micuser.

The location of the license file, if it is not one of the default places listed above, must be made known to the NAG application by setting the environment variables NAG_KUSARI_FILE and MIC_NAG_KUSARI_FILE to the full pathname of the file before the application is invoked.

For example, in the C-shell, type:

  setenv NAG_KUSARI_FILE [INSTALL_DIR]/license.lic
  setenv MIC_ENV_PREFIX=MIC
  setenv MIC_NAG_KUSARI_FILE [INSTALL_DIR]/license.lic
or in the Bourne shell, type:
  NAG_KUSARI_FILE=[INSTALL_DIR]/license.lic
  export NAG_KUSARI_FILE
  MIC_ENV_PREFIX=MIC
  export MIC_ENV_PREFIX
  MIC_NAG_KUSARI_FILE=[INSTALL_DIR]/license.lic
  export MIC_NAG_KUSARI_FILE

Note that the location of MIC_NAG_KUSARI_FILE must be mounted on the Xeon Phi and be readable by "all". This environment variable is passed to the coprocessor when running in offload mode. In native mode only NAG_KUSARI_FILE need be set after ssh-ing into the device.

Further details about Kusari and how it may be configured to suit your local circumstances (e.g. how to install the license keys on a server) are included in the Kusari License Management documentation in the license/doc/ subdirectory of the software distribution. However, note that the licence key for the Intel Xeon Phi coprocessor cannot be provided by a licence server - it must be contained in a key file accessible from the coprocessor. See also the Kusari FAQ:

http://www.nag.co.uk/Kusari/kusari_faq.html

4.2. Release to Users

The Users' Note (doc/un.html) should be checked and amended as necessary (particularly Sections 3.1, 3.3 and 5). Advice on accessing the library (see Users' Note, Section 3.1) can be checked by running a few example programs following that advice; a suitable sample would be D01AUF, E04UCA and F07ADF. The installation can also be tested using the nagsmp_example and nagsmp_example_shar etc. scripts (see Users' Note, Section 3.3). The Users' Note (doc/un.html) should then be made available to users directly, or be absorbed into local access information.

The following material should also be made accessible to users:

documentation files:

The nagdoc_Intel_MIC_FS23.3 directory contains the Library Manual.

compiled libraries:

  libnagsmp.a
  libnagsmp.so
  libnag_performance_parameters.a
  libnag_performance_parametersMIC.a
  libnag_performance_parameters_sb1.a
  libnag_performance_parameters_sb1MIC.a
  libnag_performance_parameters_sb1.so
  libnag_performance_parameters_sb2.a
  libnag_performance_parameters_sb2MIC.a
  libnag_performance_parameters_sb2.so
  libnag_performance_parameters.so
  libnagsmpMIC.a
  Intel ® Math Kernel libraries supplied by NAG
interface block files:
  nag_interface_blocks/*
example program material:
  examples/source/??????e.f90
  examples/data/??????e.d
  examples/data/??????e.opt
  examples/results/??????e.r
  scripts/nagsmp_example
  scripts/nagsmp_example_shar
  scripts/nagsmp_example_native
  scripts/nagsmp_example_shar_native

Note that the example material has been adapted, if necessary, from that published in the Library Manual, so that programs are suitable for execution with this implementation with no further changes (but see Section 3.3 of the Users' Note for comments about possible differences in results obtained). Making the example material directly available to users provides them with easily adaptable templates for their own problems.

4.3. Further Information

4.3.1. Maintenance Level

The maintenance level of the Library can be determined by compiling and executing the example that calls A00AAF, or you could call the script nagsmp_example with the arguments a00aaf 1. See Users' Note, Section 3.3. This example prints out details of the implementation, including title and product code, compiler and precision used, mark and maintenance level.

5. Support from NAG

(a) Contact with NAG

Queries concerning this document or the implementation generally should be directed to NAG at one of the addresses given in the Appendix. Users subscribing to the support service are encouraged to contact one of the NAG Response Centres (see below).

(b) NAG Response Centres

The NAG Response Centres are available for general enquiries from all users and also for technical queries from sites with an annually licensed product or support service.

The Response Centres are open during office hours, but contact is possible by fax, email and phone (answering machine) at all times.

When contacting a Response Centre, it helps us deal with your enquiry quickly if you can quote your NAG site reference or account number and NAG product code (in this case FSLM623DCL).

(c) NAG Websites

The NAG websites provide information about implementation availability, descriptions of products, downloadable software, product documentation and technical reports. The NAG websites can be accessed at the following URLs:

http://www.nag.co.uk/, http://www.nag.com/, http://www.nag-j.co.jp/ or http://www.nag-gc.com/

(d) NAG Electronic Newsletter

If you would like to be kept up to date with news from NAG then please register to receive our free electronic newsletter, which will alert you to announcements about new products or product/service enhancements, technical tips, customer stories and NAG's event diary. You can register via one of our websites, or by contacting us at nagnews@nag.co.uk.

(e) Product Registration

To ensure that you receive information on updates and other relevant announcements, please register this product with us. For NAG Library products this may be accomplished by filling in the online registration form at http://www.nag.co.uk/numeric/Library_Registration.asp.

6. User Feedback

Many factors influence the way that NAG's products and services evolve, and your ideas are invaluable in helping us to ensure that we meet your needs. If you would like to contribute to this process, we would be delighted to receive your comments. Please contact any of the NAG Response Centres (shown below).

Appendix - Contact Addresses

NAG Ltd
Wilkinson House
Jordan Hill Road
OXFORD  OX2 8DR                         NAG Ltd Response Centre
United Kingdom                          email: support@nag.co.uk

Tel: +44 (0)1865 511245                 Tel: +44 (0)1865 311744
Fax: +44 (0)1865 310139                 Fax: +44 (0)1865 310139

NAG Inc
801 Warrenville Road
Suite 185
Lisle, IL  60532-4332                   NAG Inc Response Center
USA                                     email: support@nag.com

Tel: +1 630 971 2337                    Tel: +1 630 971 2337
Fax: +1 630 971 2706                    Fax: +1 630 971 2706

Nihon NAG KK
Hatchobori Frontier Building 2F
4-9-9
Hatchobori
Chuo-ku
Tokyo 104-0032                          Nihon NAG Response Centre
Japan                                   email: support@nag-j.co.jp

Tel: +81 3 5542 6311                    Tel: +81 3 5542 6311
Fax: +81 3 5542 6312                    Fax: +81 3 5542 6312

NAG Taiwan Branch Office
5F.-5, No.36, Sec.3
Minsheng E. Rd.
Taipei City 10480                       NAG Taiwan Response Centre
Taiwan                                  email: support@nag-gc.com

Tel: +886 2 25093288                    Tel: +886 2 25093288
Fax: +886 2 25091798                    Fax: +886 2 25091798