This page describes the installation and usage of the binary distribution of OdinMP/CCp, an OpenMP compiler for C-programs and platforms supporting POSIX threads.
These installation instructions assume that you have fetched the OdinMP/CCp archive, odinmp-1.01.tar.gz.
The number 1.01 refers to the version of OdinMP/CCp. Replace 1.01 in the instructions below with whatever version number there is on the archive that you have fetched.
gzcat tempdir/odinmp-1.01.tar.gz | tar -xvf -
This will create a subdirectory odinmp-binary-1.01 beneath the current directory, which contains all the necessary OdinMP files.
The sub-directory odinmp contains the actual program.
You have now unpacked the OdinMP/CCp files.
Before you can begin using OdinMP/CCp, you must inform the OdinMP/CCp system where it is installed:
###################################################################### # Edit this to point to the dircetory where you installed OdinMP/CCp # # # $odinmp_home = "INSTALLDIR/odinmp"; # # ######################################################################
Replace 'INSTALLDIR' (or whatever is in its place) with 'install-root' . If your install-root is /usr/local, then the line should read exactly
$odinmp_home = "/usr/local/odinmp";
OpenMP programs compiled with OdinMP can run on any platform supporting POSIX threads.
In order for the compiler to work, OdinMP/CCp requires two things.
The programs in install-root/odinmp/bin/ are Perl version 5 programs. They expect Perl version 5 to be installed somewhere in your search path, so that it can be found by /usr/bin/env . If the programs won't immediately run on your system, modify the top line of each program to point to the correct location for Perl version 5.
A Java runtime, version 1.1 or newer, which must be in the program search path, such as identifed by the PATH environment variable. This is used by the install-root/odinmp/bin/OdinMP program. If necessary, you can edit install-root/odinmp/bin/OdinMP to explicitly point out the java interpreter you require.
Consider that you have a program foobar, compiled from files foo.c and bar.c, which you wish to parallelize through OdinMP/CCp. Here is a description, step by step, of what you need to do.
This places you in the directory which contains the original source files for your program foo.c and bar.c .
Run the command
odinmp_prep --output=foobar --targetDirectory=foobar_parallel foo.c bar.c
This will create a directory called foobar_parallel, and in that directory a makefile and symbolic links to the files 'omp.c' and 'omp.h' as supplied with OdinMP/CCp.
This places you in the same directory as the generated makefile.
This will call upon OdinMP/CCp to walk through the files specified on the odinmp_prep command line, parallelizing each one, and generating a corresponding output file in the current directory. Each generated C source file will be compiled, and finally all object files get linked to form the resulting program.
The sub-directory omp_examples contains two simple OpenMP programs with makefiles. When you have installed OdinMP/CCp, change directory to one of the example programs and build the program by typing "make".
A simple program that calculates pi. Should have near linear speedup.
This program is a C-version of the program MD that can be obtained at the official OpenMP web site (http://www.openmp.org).
odinmp_prep [--output=output] [--targetDirectory=targetDirectory] [--targetDebug=(always|runtime|never)] [--targetTiming=(always|runtime|never)] source-files
odinmp_prep prepares a project of C language source code files for OdinMP parallelization, by the following steps:
OdinMP [--targetDirectory=targetDirectory] [--targetTiming=(always|runtime|never)] [--targetDebug=(always|runtime|never)] [--cpp=cpp] [--cc=cc] [--numProcessors=numProcessors] [--numThreads=numThreads] source-files
OdinMP performs the actual compilation from C with OpenMP directives, to C with pthreads library calls.
Files are read from the current directory and generated to targetDirectory. If targetDirectory is not specified, it defaults to 'odinmp_ccd'.
The 'targetTiming' option specifies whethet OdinMP/CCp will include timing code in the generated code, and whether timing will actually be performed. If targetTiming is 'never', no code is generated. If targetTiming is 'runtime', code is generated which will allow the resulting program to print timing information if called with the '--odinmp_timing' command line option. If targetTiming is 'always', the generated code will always measure and report timing information. The default value for targetTiming is 'never.
The 'targetDebug' option specifies whethet OdinMP/CCp will include debugging code in the generated code, and whether debugging messages will actually be printed. If targetDebug is 'never', no code is generated. If targetDebug is 'runtime', code is generated which will allow the resulting program to print debug information if called with the '--odinmp_debug' command line option. If targetDebug is 'always', the generated code will always print debugging information. The default value for targetDebug is 'never.
The '--cpp=cpp' option specifies an alternate C preprocessor to use for preprocessing the input C source files. The default is 'install-root/odinmp/bin/cppp'.
The '--cc=cc' option selects an alternate C compiler to use for compiling the generated C source files. The default is 'install-root/odinmp/bin/ccc'.
cppp [options] < input > output
cppp reads un-preprocessed C source code from its standard input, preprocesses it, and prints the result to its standard output.
cppp is implemented as a Perl script which wraps around various different C preprocessors. By setting the variable '$cpp' at the top of the script, one of several underlying C preprocessors can be selected. The purpose of cppp is to insulate OdinMP from the particular semantics of how the underlying C preprocessor accepts and generates data.
The environment variable ODINMP_CPP can be used to override the contents of the $cpp variable specified in the script at runtime.
ccc [options] source-files
ccc compiles the C source code specified into object files, or links the object files specified into an executable.
ccc is implemented as a Perl script which wraps around various different C compilers. By setting the variable '$cc' at the top of the script, one of several underlying C compilers can be selected. The purpose of ccc is to insulate OdinMP from the particular semantics of how the underlying C compiler wants its arguments.
The environment variable ODINMP_CC can be used to override the contents of the $cc variable specified in the script at runtime.