flexiblas - Man Page

If application are build against FlexiBLAS, there are severval ways to select the active BLAS library. The installed (and known) BLAS backends can be listed via

   flexiblas list

The default BLAS backend can be set using

  flexiblas default NAME_OF_THE_LIBRARY

If the BLAS backend should only be set temporary, this can be done via the FLEXIBLAS environment  variable. This can either be set to a name of a BLAS backend (from flexiblas list)

   FLEXIBLAS=NAME_OF_THE_LIBRARY  ./yourapp

or to the path of a shared object containing a BLAS implementation

   FLEXIBLAS="/usr/lib/libyourblas.so" ./yourapp

FlexiBLAS supports so called hooks to modify/extent/change the behavior of BLAS and LAPACK functions. This can be used for profiling, automatic offloadlind, and other debuging purposes. The hooks are configured either via the FLEXIBLAS_HOOK environment variable or the flexiblas tool. The FLEXIBLAS_HOOK variable contains a colon separate list of hooks or shared libraries containing the hook. The hooks are loaded in the order they are specified. If the hook_enabled setting in a configuration file is set but empty all hooks are disabled for this configuration file. In this way the per host setting can disable the user settings. Using the hook disableall command the hook_enabled entry is removed and thus no hook settings are in the configuration.

FlexiBLAS uses serveral configuration paths to select the BLAS backend or enable and disable other functionality. The configuration is read in the following order, thereby previous read information is overwritten. That means that last read configuration has the highest priority.

1. /etc/flexiblasrc - The system wide configuration file, hooks can not be configured here.

2. /etc/flexiblasrc.d/*.conf - Additional system wide configurations, read only.

3. ${HOME}/flexiblasrc - The user's configuration file.

4. ${HOME}/flexiblasrc.$(hostname) - The user's configuration file on a host, useful for NFS homedirectories.

5. FLEXIBLAS_CONFIG - The environment variable is used to specified a separate configuration file, e.g. per project.

6. FLEXIBLAS, FLEXIBLAS_HOOK - Select a BLAS implementation or a hook without changing the config.

If FlexiBLAS is compiled with 64 bit intergers, flexiblas is replaced by flexiblas64 and FLEXIBLAS is replaced by FLEXIBLAS64 in all names of configuration files, environment variable, etc.

help

Print information about the tool and its usage.

print

Print the whole BLAS related configuration including search paths, default settings, etc.

list

List all available BLAS libraries from the configuration files.

default BLASNAME

Sets the default BLAS backend in the selected configuration file.

default

Removes the default setting from the selected configuration file.

add BLASNAME sharedlibrary.so ["comment string"]

Add a new BLAS backend called "BLASNAME" to the selected configuration file. This will create a section like

  [BLASNAME]
  library=sharedlibrary.so
  comment="comment string"

in the selected configuration file. The comment string is optional.

remove NAME

Remove a BLAS backed called "NAME" from the selected configuration file.

set property [value]

Set a property in the configuration file. If the value is not given the property is reset to its default. The available properties are listed below.

Hooks are additional plugins that integrate in the call of a BLAS or LAPACK function. They are used for debugging or profiling purpose.

hook list

List all available hooks. The hooks are automatically found in the FlexiBLAS library directories.

hook show hook-name

Show details about a specific hook. This includes the name, the authors, a short description, and the list of configurable options.

hook enable hook-name

Enable a hook. If more than one hook is enabled they are executed in the order they got enabled.

hook disable hook-name

Disable a hook.

hook disableall

Disable all hooks in a configuration and remove the setting from the configuration. This is necessary if, i.e., hooks are enabled in the user configuration and the host configuration file has an empty hook_enabled field. In this case the FlexiBLAS does not use a hook since the host configuration overwrites the user configuration. Then hook disableall is used to remove the hook_enabled from the host configuration.

hook enabled

Show all enabled hooks in the configuration files.

hook active

Show the currently active hooks and from which configuration file they are loaded.

hook set hook-name option-name value

Set an option for a hook to the given value. All available options for a hook can be shown with the hook show command. Bhook unset hook-name option-name Unset an option for a hook.

-u,  --user

Edit the user's flexiblasrc configuration (default options, except of executing as root).

-g,  --global

Edit the global flexiblasrc configuration (default in case of executing as root).

-H,  --host

Edit the host configuration file.

-E,  --environment

Edit the configuration file given by the environment variable FLEXIBLAS_CONFIG.

-p,  --pipe

Make the output of some commands, like list pipe compatible to use them in scripts.

-h,  --help

Print this information and exit.

-v,  --version

Print the versionformation and exit.

verbose integer

Change the verbosity level of FlexiBLAS. The default verbosity level is 0 which only displays critical errors. If a level larger than is specified, FlexiBLAS will produce many debug information on stderr.

nolapack integer

If the value is non zero, FlexiBLAS does not load the LAPACK functions from the backend. That means that only the internal LAPACK routines are used.