Plot performance profiles, int16 and int64 #111
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Plot performance profiles, int16 and int64 | |
| on: | |
| # Trigger the workflow on push or pull request | |
| #push: | |
| #pull_request: # DANGEROUS! MUST be disabled for self-hosted runners! | |
| # Trigger the workflow by cron. The default time zone of GitHub Actions is UTC. | |
| schedule: | |
| - cron: '0 4 3-31/4 * *' | |
| # Trigger the workflow manually | |
| workflow_dispatch: | |
| inputs: | |
| git-ref: | |
| description: Git Ref (Optional) | |
| required: false | |
| # Show the git ref in the workflow name if it is invoked manually. | |
| run-name: ${{ github.event_name == 'workflow_dispatch' && format('Manual run {0}', inputs.git-ref) || '' }} | |
| jobs: | |
| test: | |
| name: Profile PRIMA. | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| matlab: [latest] | |
| ik: [16, 64] | |
| dim: [all] | |
| solver: [cobylal, cobylan, uobyqa, newuoa, bobyqa, lincoa] # prima is too expensive | |
| compiler_options: [-O0, -O1, -O2, -O3, -Ofast -fno-stack-arrays, -ffast-math] | |
| competitor: [norma] | |
| use_system_libgcc: [true] # Whether to use the system libgcc or the one shipped with MATLAB. | |
| steps: | |
| - name: Get the solver name | |
| run: echo "SOLNAME=$(echo ${{ matrix.solver }} | cut -c1-6)" >> $GITHUB_ENV | |
| - name: Run `sudo apt update` | |
| run: sudo apt update || true # Otherwise, free-disk-space or other actions relying on `apt` may fail | |
| - name: Free disk space | |
| uses: jlumbroso/free-disk-space@main | |
| with: | |
| # all of these default to true, but feel free to set to "false" if necessary for your workflow | |
| android: true | |
| dotnet: true | |
| haskell: true | |
| large-packages: true | |
| docker-images: true | |
| swap-storage: false # Important, or the runner may be shut down due to memory starvation. | |
| - name: Clone Repository (Latest) | |
| uses: actions/checkout@v6.0.2 | |
| if: github.event.inputs.git-ref == '' | |
| with: | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| submodules: recursive | |
| - name: Clone Repository (Custom Ref) | |
| uses: actions/checkout@v6.0.2 | |
| if: github.event.inputs.git-ref != '' | |
| with: | |
| ref: ${{ github.event.inputs.git-ref }} | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| submodules: recursive | |
| - name: Miscellaneous setup | |
| run: bash .github/scripts/misc_setup | |
| - name: Clone MatCUTEst | |
| uses: actions/checkout@v6.0.2 | |
| with: | |
| ssh-key: ${{ secrets.SSH_PRIVATE_KEY_ACT }} # This forces checkout to use SSH, not HTTPS | |
| repository: matcutest/matcutest_compiled | |
| path: matcutest | |
| - name: Set up gfortran on Linux | |
| if: startsWith(matrix.os, 'ubuntu') | |
| uses: fortran-lang/setup-fortran@main | |
| with: | |
| compiler: gcc | |
| version: latest | |
| - name: Check gfortran version on Linux | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: which gcc && gcc --version && which gfortran && gfortran --version | |
| - name: Install epstopdf and ghostscript | |
| if: startsWith(matrix.os, 'ubuntu') | |
| run: bash .github/scripts/install_epstopdf && bash .github/scripts/install_ghostscript | |
| - name: Set up MATLAB with optimization toolbox | |
| uses: matlab-actions/setup-matlab@v2.6.1 | |
| with: | |
| release: ${{ matrix.matlab }} | |
| cache: true | |
| products: Optimization_Toolbox Parallel_Computing_Toolbox | |
| - name: Revise the Fortran code to use the intended integer kind. Do NOT use `options.integer_kind`, because it will change the integer kind for the competitor as well. | |
| run: | | |
| $SEDI "s|#define PRIMA_INTEGER_KIND 0|#define PRIMA_INTEGER_KIND ${{ matrix.ik }}|g" fortran/common/ppf.h | |
| - name: Revise get_solvers.m to print the revised header file | |
| run: | | |
| cd matlab/tests/private || exit 1 | |
| $SEDI "s|\(^.*\)\(setup(solver.*$\)|\1header_file\n\1system(['cat ', header_file]);\n\1\2|" get_solvers.m | |
| - name: Revise setup_compiler_options.m to print the revised mexopt file | |
| run: | | |
| cd matlab/tests/private || exit 1 | |
| $SEDI "s|return|for ifile = 1 : length(config_files), ifile, cfile = fullfile(config_dir, config_files{ifile}) , system(['cat ', cfile]); end|" set_compiler_options.m | |
| - name: Link system libgcc to MATLAB if needed | |
| if: startsWith(matrix.os, 'ubuntu') | |
| shell: bash | |
| run: | | |
| matlab_root=$(realpath $(dirname $(which matlab))/../) | |
| echo "MATLAB root is ${matlab_root}" | |
| matlab_libgcc="${matlab_root}/sys/os/glnxa64/libgcc_s.so.1" | |
| echo "MATLAB libgcc is:" | |
| ls -alh ${matlab_libgcc} || exit 42 | |
| echo "gcc strings in MATLAB libgcc are:" | |
| strings ${matlab_libgcc} | grep -iE "^GCC_" | |
| echo "latest gcc version string in MATLAB libgcc is:" | |
| readelf -V ${matlab_libgcc} | grep -oiE 'GCC_([0-9]+)(.[0-9]+){0,2}' | sort -V | tail -1 | |
| system_libgcc="/usr/lib/x86_64-linux-gnu/libgcc_s.so.1" | |
| echo "System libgcc is:" | |
| ls -alh ${system_libgcc} || exit 42 | |
| echo "gcc strings in system libgcc are:" | |
| strings ${system_libgcc} | grep -iE "^GCC_" | |
| echo "latest gcc version string in system libgcc is:" | |
| readelf -V ${system_libgcc} | grep -oiE 'GCC_([0-9]+)(.[0-9]+){0,2}' | sort -V | tail -1 | |
| if [[ "${{ matrix.use_system_libgcc }}" == "true" ]] ; then | |
| ln -sf ${system_libgcc} ${matlab_libgcc} || exit 42 | |
| echo "Linked ${system_libgcc} to ${matlab_libgcc}." | |
| else | |
| echo "Keep ${matlab_libgcc} untouched." | |
| fi | |
| echo "After the operation, MATLAB libgcc is:" | |
| ls -alh ${matlab_libgcc} || exit 42 | |
| echo "gcc strings in MATLAB libgcc are:" | |
| strings ${matlab_libgcc} | grep -iE "^GCC_" | |
| echo "latest gcc version string in MATLAB libgcc is:" | |
| readelf -V ${matlab_libgcc} | grep -oiE 'GCC_([0-9]+)(.[0-9]+){0,2}' | sort -V | tail -1 | |
| - name: Revise getMexLibgcc and compiled.m to print necessary information | |
| shell: bash | |
| run: | | |
| cd matlab/setup_tools || exit 42 | |
| $SEDI 's|\(.*lddOut.*\);|\1|' getMexLibgcc.m | |
| $SEDI 's|\(.*Path.*\);|\1|' getMexLibgcc.m | |
| $SEDI 's|\(.*String.*\);|\1|' getMexLibgcc.m | |
| $SEDI 's|\(.*Version.*\);|\1|' getMexLibgcc.m | |
| cat getMexLibgcc.m | |
| $SEDI 's|\(common_mex_options\s*=\s*.*$\)$|\1\ncommon_mex_options{:}|' compile.m | |
| $SEDI 's|\(.*\s*=\s*getMexLibgcc().gccVersion.*\)|\1\ngetMexLibgcc() |' compile.m | |
| $SEDI 's|\(.*_version\s*=\s*.*\);|\1 |' compile.m | |
| $SEDI 's|\(compiler_options\s*=\s*.*\);|\1 |' compile.m | |
| $SEDI "s|\(if\s*~support_internal_procedures\)|verLessThan('matlab', '25.1'), verLessThan('matlab', '25.2'), compiler_manufacturer, compiler_options, support_internal_procedures\n\1|" compile.m | |
| cat compile.m | |
| - name: Conduct the test | |
| uses: equipez/run-matlab-command@v2 | |
| with: | |
| timelimit: 320m | |
| command: | | |
| ver; | |
| root_dir = pwd(); | |
| cd(fullfile(root_dir, 'matcutest')); install(); which macup | |
| cd(fullfile(root_dir, 'matlab/tests')); | |
| options = struct(); | |
| options.compiler_options = '${{ matrix.compiler_options }}'; | |
| options.debug = ~contains('${{ matrix.compiler_options }}', 'fast') | |
| options.nr = 3; % random runs for each problem | |
| if strcmp('${{ matrix.solver }}', 'cobylal') | |
| prof('cobyla', '${{ matrix.dim }}', 'l', '${{ matrix.competitor }}', options); | |
| elseif strcmp('${{ matrix.solver }}', 'cobylan') | |
| options.blacklist = {'CERI651B', 'HS99EXP', 'TRO6X2', 'POLAK2', 'GBRAIN', 'HIMMELP6','ORTHREGB', 'PRODPL0', 'DISCS', 'PRODPL1', 'DNIEPER', 'VESUVIA', 'OPTPRLOC', 'NET1', 'CERI651D', 'TRO3X3', 'ERRINROSNE', 'HS85', 'ERRINROSNE', 'DEMBO7', 'POLAK6', 'OSBORNE2'}; | |
| prof('cobyla', '${{ matrix.dim }}', 'n', '${{ matrix.competitor }}', options); | |
| elseif strcmp('${{ matrix.solver }}', 'lincoa') | |
| options.blacklist = {'HS105'}; % Classical LINCOA encounters a SEGFAULT when compiled with -O1. | |
| options.blacklist = [options.blacklist, {'DUAL2', 'SSEBLIN', 'AGG', 'SMBANK', 'GMNCASE3', 'GMNCASE2', 'HYDROELS', 'CVXQP1', 'GMNCASE1', 'SPANHYD', 'OET3', 'DALLASS'}]; | |
| prof('${{ matrix.solver }}', '${{ matrix.dim }}', 'l', '${{ matrix.competitor }}', options); | |
| elseif strcmp('${{ matrix.solver }}', 'bobyqa') | |
| options.blacklist = {'CHEBYQAD'}; | |
| prof('${{ matrix.solver }}', '${{ matrix.dim }}', 'b', '${{ matrix.competitor }}', options); | |
| else | |
| options.blacklist={'LUKSAN11LS', 'SPIN2LS', 'ARGLINA', 'ARGLINC', 'ERRINROS', 'QING', 'METHANB8LS', 'SPIN2LS', 'COOLHANSLS', 'SENSORS', 'ARGLINB', 'BA-L1SPLS', 'LUKSAN13LS'}; | |
| prof('${{ matrix.solver }}', '${{ matrix.dim }}', '${{ matrix.competitor }}', options); | |
| end | |
| % Move the files to prepare for uploading artifacts | |
| solver = '${{ env.SOLNAME }}' | |
| cd(fullfile(cd(), 'testdata')); | |
| files = dir([solver, '*.summary.*.pdf']) | |
| for ifile = 1 : length(files) | |
| file = fullfile(files(ifile).folder, files(ifile).name) | |
| newfile = fullfile(files(ifile).folder, ['yes', '_', files(ifile).name]) | |
| movefile(file, newfile); | |
| end | |
| movefile(fullfile(cd(), '*summary*.pdf'), ['/tmp/', solver, '_profile_prima/']); | |
| movefile(fullfile(cd(), '*.txt'), ['/tmp/', solver, '_profile_prima/']); | |
| files = [dir(['/tmp/', solver, '_profile_prima/*start*']); dir(['/tmp/', solver, '_profile_prima/*end*'])] | |
| for ifile = 1 : length(files) | |
| file = fullfile(files(ifile).folder, files(ifile).name) | |
| newfile = fullfile(files(ifile).folder, ['yes', '_', files(ifile).name]) | |
| movefile(file, newfile); | |
| end | |
| - name: List problems that started but did not end | |
| # The solver got stuck when solving these problems. Investigate what happened. | |
| if: always() | |
| shell: bash | |
| run: | | |
| solver=${{ env.SOLNAME }} | |
| cd /tmp/${solver}_profile_prima/ | |
| ls -R1 *${solver}*_start > ${solver}_prob_start | |
| ls -R1 *${solver}*_end > ${solver}_prob_end | |
| diff ${solver}_prob_start ${solver}_prob_end > ${solver}_stuck || : | |
| printf "\n\n>>>>>>>>>>>>>>>>\nProblems that started but did not end:\n\n" | |
| cat ${solver}_stuck | |
| printf "\n<<<<<<<<<<<<<<<<\n\n" | |
| - name: Store artifacts | |
| uses: actions/upload-artifact@v7 | |
| if: always() # Always run even if the workflow is canceled manually or due to overtime. | |
| with: | |
| name: artifact-${{ matrix.solver }}-${{ matrix.dim }}-${{ matrix.competitor }}-${{ matrix.compiler_options }}-${{ matrix.ik }}-${{ matrix.use_system_libgcc }} | |
| path: | | |
| /tmp/${{ env.SOLNAME }}_profile_prima/*summary*.pdf | |
| /tmp/${{ env.SOLNAME }}_profile_prima/*.txt | |
| /tmp/${{ env.SOLNAME }}_profile_prima/*prob_start* | |
| /tmp/${{ env.SOLNAME }}_profile_prima/*prob_end* | |
| /tmp/${{ env.SOLNAME }}_profile_prima/*stuck* | |
| /tmp/${{ env.SOLNAME }}_profile_prima/fort.* | |
| - name: Remove the test data | |
| if: always() # Always run even if the workflow is canceled manually or due to overtime. | |
| run: rm -rf ./matlab/tests/testdata && rm -rf /tmp/${{ env.SOLNAME }}_profile_prima | |
| merge_artifacts: | |
| continue-on-error: true # As of 20240218, this action may fail if there are too many artifacts. We ignore the failure. | |
| if: always() | |
| runs-on: ubuntu-latest | |
| needs: test | |
| steps: | |
| - name: Merge Artifacts | |
| uses: actions/upload-artifact/merge@v7 | |
| with: | |
| name: 00-merged-artifacts | |
| pattern: artifact-* |