Parallel Computing Toolbox™

mpiSettings - Configure options for MPI communication

Syntax

mpiSettings('DeadlockDetection','on')
mpiSettings('MessageLogging','on')
mpiSettings('MessageLoggingDestination','CommandWindow')
mpiSettings('MessageLoggingDestination','stdout')
mpiSettings('MessageLoggingDestination','File','filename')

Description

mpiSettings('DeadlockDetection','on') turns on deadlock detection during calls to labSend and labReceive (the default is 'off' for performance reasons). If deadlock is detected, a call to labReceive might cause an error. Although it is not necessary to enable deadlock detection on all labs, this is the most useful option.

mpiSettings('MessageLogging','on') turns on MPI message logging. The default is 'off'. The default destination is the MATLAB^® Command Window.

mpiSettings('MessageLoggingDestination','CommandWindow') sends MPI logging information to the MATLAB Command Window. If the task within a parallel job is set to capture Command Window output, the MPI logging information will be present in the task's CommandWindowOutput property.

mpiSettings('MessageLoggingDestination','stdout') sends MPI logging information to the standard output for the MATLAB process. If you are using a job manager, this is the mdce service log file; if you are using an mpiexec scheduler, this is the mpiexec debug log, which you can read with getDebugLog.

mpiSettings('MessageLoggingDestination','File','filename') sends MPI logging information to the specified file.

Remarks

Setting the MessageLoggingDestination does not automatically enable message logging. A separate call is required to enable message logging.

mpiSettings has to be called on the lab, not the client. That is, it should be called within the task function, within jobStartup.m, or within taskStartup.m.

Examples

    % in "jobStartup.m" for a parallel job
    mpiSettings('DeadlockDetection', 'on');
    myLogFname = sprintf('%s_%d.log', tempname, labindex);
    mpiSettings('MessageLoggingDestination', 'File', myLogFname);
    mpiSettings('MessageLogging', 'on');

mpiprofile

NaN