Merge pull request #10 from mathworks/v2.3.0

v2.3.0

Author: jmcave

communicatingJobWrapper.sh

@@ -19,7 +19,7 @@
 # The following environment variables are set by Slurm:
 # SLURM_NODELIST - list of hostnames allocated to this Slurm job
 
-# Copyright 2015-2024 The MathWorks, Inc.
+# Copyright 2015-2025 The MathWorks, Inc.
 
 # If PARALLEL_SERVER_ environment variables are not set, assign any
 # available values with form MDCE_ for backwards compatibility
@@ -47,10 +47,17 @@ if [ ! -z "${PARALLEL_SERVER_DEBUG}" ] && [ "${PARALLEL_SERVER_DEBUG}" != "false
     MPI_VERBOSE="${MPI_VERBOSE} -v -print-all-exitcodes"
 fi
 
+if [ ! -z "${PARALLEL_SERVER_BIND_TO_CORE}" ] && [ "${PARALLEL_SERVER_BIND_TO_CORE}" != "false" ] ; then
+    BIND_TO_CORE_ARG="-bind-to core:${PARALLEL_SERVER_NUM_THREADS}"
+else
+    BIND_TO_CORE_ARG=""
+fi
+
 # Construct the command to run.
 CMD="\"${FULL_MPIEXEC}\" \
+    ${PARALLEL_SERVER_MPIEXEC_ARG} \
     -genvlist ${PARALLEL_SERVER_GENVLIST} \
-    -bind-to core:${PARALLEL_SERVER_NUM_THREADS} \
+    ${BIND_TO_CORE_ARG} \
     ${MPI_VERBOSE} \
     -n ${PARALLEL_SERVER_TOTAL_TASKS} \
     \"${PARALLEL_SERVER_MATLAB_EXE}\" \

communicatingSubmitFcn.m

@@ -93,6 +93,25 @@ function communicatingSubmitFcn(cluster, job, environmentProperties)
     'PARALLEL_SERVER_CMR', strip(cluster.ClusterMatlabRoot, 'right', '/'); ...
     'PARALLEL_SERVER_TOTAL_TASKS', num2str(environmentProperties.NumberOfTasks); ...
     'PARALLEL_SERVER_NUM_THREADS', num2str(cluster.NumThreads)};
+% Starting in R2025a, IntelMPI is supported via MPIImplementation="IntelMPI"
+if ~verLessThan('matlab', '25.1') && ...
+        isprop(cluster.AdditionalProperties, 'MPIImplementation') %#ok<VERLESSMATLAB>
+    mpiImplementation = cluster.AdditionalProperties.MPIImplementation;
+    mustBeMember(mpiImplementation, ["IntelMPI", "MPICH"]);
+    variables = [variables; {'PARALLEL_SERVER_MPIEXEC_ARG', ['-', char(mpiImplementation)]}];
+end
+
+% Avoid "-bind-to core:N" if AdditionalProperties.UseBindToCore is false (default: true).
+if validatedPropValue(cluster.AdditionalProperties, 'UseBindToCore', 'logical', true)
+    bindToCoreValue = 'true';
+else
+    bindToCoreValue = 'false';
+end
+variables = [variables; {'PARALLEL_SERVER_BIND_TO_CORE', bindToCoreValue}];
+
+if ~verLessThan('matlab', '25.1') %#ok<VERLESSMATLAB>
+    variables = [variables; environmentProperties.JobEnvironment];
+end
 % Environment variable names different prior to 19b
 if verLessThan('matlab', '9.7')
     variables(:,1) = replace(variables(:,1), 'PARALLEL_SERVER_', 'MDCE_');
@@ -118,6 +137,11 @@ function communicatingSubmitFcn(cluster, job, environmentProperties)
 % Prior to R2019a, only the SMPD process manager is supported.
 if verLessThan('matlab', '9.6') || ...
         validatedPropValue(cluster.AdditionalProperties, 'UseSmpd', 'logical', false)
+    if ~verLessThan('matlab', '25.1') %#ok<VERLESSMATLAB>
+        % Starting in R2025a, smpd launcher is not supported.
+        error('parallelexamples:GenericSLURM:SmpdNoLongerSupported', ...
+            'The smpd process manager is no longer supported.');
+    end
     jobWrapperName = 'communicatingJobWrapperSmpd.sh';
 else
     jobWrapperName = 'communicatingJobWrapper.sh';

independentSubmitFcn.m

@@ -6,7 +6,7 @@ function independentSubmitFcn(cluster, job, environmentProperties)
 %
 % See also parallel.cluster.generic.independentDecodeFcn.
 
-% Copyright 2010-2023 The MathWorks, Inc.
+% Copyright 2010-2024 The MathWorks, Inc.
 
 % Store the current filename for the errors, warnings and dctSchedulerMessages.
 currFilename = mfilename;
@@ -97,6 +97,9 @@ function independentSubmitFcn(cluster, job, environmentProperties)
     'MLM_WEB_ID', environmentProperties.LicenseWebID; ...
     'PARALLEL_SERVER_LICENSE_NUMBER', environmentProperties.LicenseNumber; ...
     'PARALLEL_SERVER_STORAGE_LOCATION', storageLocation};
+if ~verLessThan('matlab', '25.1') %#ok<VERLESSMATLAB>
+    variables = [variables; environmentProperties.JobEnvironment];
+end
 % Environment variable names different prior to 19b
 if verLessThan('matlab', '9.7')
     variables(:,1) = replace(variables(:,1), 'PARALLEL_SERVER_', 'MDCE_');

private/createSubmitScript.m

@@ -21,9 +21,11 @@ function createSubmitScript(outputFilename, jobName, quotedLogFile, ...
 % Specify shell to use
 fprintf(fid, '#!/bin/sh\n');
 
-% Unset all SLURM_ and SBATCH_ variables to avoid conflicting options in nested jobs
+% Unset all SLURM_ and SBATCH_ variables to avoid conflicting options in
+% nested jobs, except for SLURM_CONF which is required for the Slurm
+% utilities to work
 fprintf(fid, '%s\n', ...
-    'for VAR_NAME in $(env | cut -d= -f1 | grep -E ''^(SLURM_|SBATCH_)''); do', ...
+    'for VAR_NAME in $(env | cut -d= -f1 | grep -E ''^(SLURM_|SBATCH_)'' | grep -v ''^SLURM_CONF$''); do', ...
     '    unset "$VAR_NAME"', ...
     'done');
 

private/runSchedulerCommand.m

@@ -1,7 +1,7 @@
 function [status, result] = runSchedulerCommand(cluster, cmd)
 %RUNSCHEDULERCOMMAND Run a command on the cluster.
 
-% Copyright 2019-2022 The MathWorks, Inc.
+% Copyright 2019-2024 The MathWorks, Inc.
 
 persistent wrapper
 
@@ -17,17 +17,22 @@
         % the system call to the scheduler on UNIX within a shell script to
         % sanitize any exit codes in this range.
         if isempty(wrapper)
-            if verLessThan('matlab', '9.7') % folder renamed in 19b
-                dirName = 'distcomp';
-            else
-                dirName = 'parallel';
-            end
-            wrapper = fullfile(toolboxdir(dirName), ...
-                'bin', 'util', 'shellWrapper.sh'); %#ok<*DCRENAME>
+            wrapper = iBuildWrapperPath();
         end
         cmd = sprintf('%s %s', wrapper, cmd);
     end
     [status, result] = system(cmd);
 end
 
 end
+
+function wrapper = iBuildWrapperPath()
+if verLessThan('matlab', '9.7')
+    pctDir = toolboxdir('distcomp'); %#ok<*DCRENAME>
+elseif verLessThan('matlab', '25.1') %#ok<*VERLESSMATLAB>
+    pctDir = toolboxdir('parallel');
+else
+    pctDir = fullfile(matlabroot, 'toolbox', 'parallel');
+end
+wrapper = fullfile(pctDir, 'bin', 'util', 'shellWrapper.sh');
+end