1. 1 Introduction
1.1. 1.1 Scope
Establish a standard method for laying out the common libraries to be used by components in a workflow. The complexity lies in the fact that components may be compiled with different library versions and even different compilers and versions of them, so the library layout must enable dynamically loading the relevant library for each workflow component.
1.2. 1.2 Background and decision status
- The previous method used by the “ITM” is judged too complicate to maintain in the long term, so some adaptation should be made at the occasion of the transition to IMAS.
- IO provides only a framework where local sysadmins add their own path extensions to the user environment, because of no control on how other dependencies will be resolved on future systems (see discussions with IO on this topic: IMAS-1188, IMAS-1484, IMAS-1072, IMAS-1888),
Taking these factors into consideration CPT proposes "EUROfusion flavor" of library modules and related layout.
2. 2 Assumptions
2.1. 2.1 Usage scenario:
- User defines compiler being used and loads all IMAS/EF DD not dependent libraries / tools
module load wpcdenv[/<compiler_vendor>/<compiler_version>/<version of this module>]
- User load
imas module
plus all components dependent on IMAS/Data Dictionarymodule load imasenv[/<imas_ver>/ual/<engine_ver>/<version of this module>]
- User cherry-picks version of library
module switch <imas_lib>
2.2. 2.2 Assumptions
imaslibs
andimasenv
modules have to be loaded prior to<imas_lib>
module <imas_lib>
can be only switched
3. 3 Modules and packages
3.1. 3.1 Module names
The module name explicitly identifies the library’s name and version and the compiler’s name and version.
module switch <LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER> E.g.: module switch ggd/1.8.0[/intel/17/imas/3.21.0/]
- Each module is conflicting with the others (of the same library).
- Meta-modules allowing loading at once all modules in a coherent environment for a given workflow/application (if not conflicting) will be available.
- In case a complex workflow/application contains components using conflicting libraries (i.e. using different versions/compilers for the same library), the relevant module must be loaded (switched) prior to the component compilation, and then unloaded.
Naming convention for compilers
GNU Compiler Collection -> gcc Intel -> intel
3.2. 3.2 Package names
pkg-config --cflags --libs <LIB_NAME> E.g.: pkg-config --cflags --libs ggd
- Please notice that there are no longer <LIB_NAME>-<COMPILER_NAME> (e.g. ggd-ifort packages), as given module could be loaded for one compiler only
4. 4. RPATH - library discovery at runtime
Actors that consist any workflow can be compiled with different versions of particular library. To allow an actor to resolve all dependent libraries at runtime,
every package
of the library, beside providing info about includes
(*.h, *.mod) and library
(*.so, *.a) has to provide RPATH.
>> pkg-config --cflags --libs <LIB_NAME> >> -Iinclude -Llib -lshared -Wl,-rpath,$(CURDIR)/lib
This way, each code at runtime will refer to version of library used for linking.
Pros | Cons |
---|---|
|
|
5. 5 Library directory layout
The library layout explicitly identifies the library’s name and version and the compiler’s name and version and puts the various files of the library as follows:
<ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/include/*.h <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/include/*.mod <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/lib/*.a <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/lib/*.so <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/lib/pkgconfig/<LIB_NAME>.pc <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/src <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/example <ROOT_LIB_PATH>/<LIB_NAME>/<LIB_VERSION>/<COMPILER_NAME>/<COMPILER_VERSION>/imas/<DD_VER>/man
ggd `-- 1.8.0 |-- gcc | `-- 6 | `-- imas | `-- 3.21.0 | |-- include | | |-- ids_assert.mod | | |-- **** | | `-- ids_utility.mod | `-- lib | |-- libggd.a | `-- pkgconfig | `-- ggd.pc `-- intel `-- 17 `-- imas `-- 3.21.0 |-- include | |-- ids_assert.mod | |-- **** | `-- ids_utility.mod `-- lib |-- libggd.a `-- pkgconfig `-- ggd.p
4.