all: prepare for release

Also, de-compressing arm64 shlib restores .init_array[0],
although supposedly *_RELATIVE relocation should overwrite.

https://github.com/upx/upx/issues/693
	modified:   p_lx_elf.cpp
	modified:   p_lx_elf.h

.clang-format

@@ -0,0 +1,49 @@
+# "Gofmt's style is nobody's favourite, but gofmt is everybody's favourite." --Rob Pike
+#
+# for clang-format-15.0.6 from https://github.com/upx/upx-stubtools/releases
+---
+BasedOnStyle: LLVM
+ColumnLimit: 100
+IndentWidth: 4
+---
+Language: Cpp
+AccessModifierOffset: -4
+AlwaysBreakTemplateDeclarations: true
+AttributeMacros:
+  - __acc_cdecl
+  - __acc_cdecl_atexit
+  - __acc_cdecl_qsort
+  - __acc_cdecl_sighandler
+  - __acc_forceinline
+  - __acc_noinline
+  - __acc_static_forceinline
+  - __acc_static_noinline
+  - DELETED_FUNCTION
+  - XSPAN_DELETED_FUNCTION
+  - forceinline
+  - may_throw
+  - noinline
+  - static_forceinline
+  - static_noinline
+EmptyLineBeforeAccessModifier: Leave
+SortIncludes: false
+SpaceAfterCStyleCast: true
+Standard: Cpp03
+StatementMacros:
+  - ACCCHK_ASSERT
+  - ACCCHK_ASSERT_IS_SIGNED_T
+  - ACCCHK_ASSERT_IS_UNSIGNED_T
+  - ACCCHK_ASSERT_SIGN_T
+  - ACC_BLOCK_BEGIN
+  - ACC_COMPILE_TIME_ASSERT
+  - ACC_COMPILE_TIME_ASSERT_HEADER
+  - ACC_CXX_DISABLE_NEW_DELETE
+  - ACC_CXX_TRIGGER_FUNCTION
+  - ACC_CXX_TRIGGER_FUNCTION_IMPL
+  - CLANG_FORMAT_DUMMY_STATEMENT
+  - COMPILE_TIME_ASSERT
+  - COMPILE_TIME_ASSERT_ALIGNED1
+WhitespaceSensitiveMacros:
+  - ACC_PP_MACRO_EXPAND
+  - ACC_PP_STRINGIZE
+...

.clang-tidy

@@ -0,0 +1,30 @@
+# for clang-tidy-16 from https://clang.llvm.org/extra/clang-tidy/
+---
+Checks: >
+  -*,
+  bugprone-*,
+    -bugprone-assignment-in-if-condition,
+    -bugprone-branch-clone,
+    -bugprone-easily-swappable-parameters,
+    -bugprone-empty-catch,
+    -bugprone-implicit-widening-of-multiplication-result,
+    -bugprone-macro-parentheses,
+    -bugprone-narrowing-conversions,
+    -bugprone-reserved-identifier,
+    -bugprone-sizeof-expression,
+    -bugprone-suspicious-include,
+    -bugprone-suspicious-memory-comparison,
+    -bugprone-suspicious-string-compare,
+    -bugprone-switch-missing-default-case,
+  clang-analyzer-*,
+    -clang-analyzer-optin.performance.Padding,
+    -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,
+    -clang-analyzer-security.insecureAPI.strcpy,
+  clang-diagnostics-*',
+  performance-*,
+    -performance-avoid-endl,
+    -performance-unnecessary-value-param,
+FormatStyle: file
+HeaderFilterRegex: '.*'
+InheritParentConfig: false
+...

.cvsignore

@@ -1,5 +0,0 @@
-.cvsignore
-.mfxcvsup
-ChangeLog.cvs*
-build
-maint

.editorconfig

@@ -0,0 +1,21 @@
+# see https://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{GNUmakefile*,MMakefile*,Makefile*,Makevars*,*.mk}]
+indent_size = 8
+indent_style = tab
+
+[*.S]
+indent_size = 8
+
+[*.yml]
+indent_size = 2

.gitattributes

@@ -0,0 +1,28 @@
+# see https://github.com/github-linguist/linguist
+#
+# HINT: check settings with
+#   git ls-files | git check-attr --stdin --all
+
+#
+# tell diff tools that these files are generated automatically
+#
+
+/doc/upx.1                              linguist-generated
+/doc/upx-doc.*                          linguist-generated
+
+/src/stub/*.h                           linguist-generated
+/src/stub/src/arch/**/lzma_d_c[fns].S   linguist-generated
+/src/stub/tmp/**                        linguist-generated
+
+#
+# make GitHub language detection more accurate
+#
+
+/src/*.h                                linguist-language=C++
+/src/*/*.h                              linguist-language=C++
+
+/src/stub/**/*.ash                      linguist-language=Assembly
+/src/stub/**/*.asm                      linguist-language=Assembly
+/src/stub/**/*.S                        linguist-language=Assembly
+
+/src/stub/tmp/**                        linguist-vendored

.github/CODEOWNERS

@@ -0,0 +1,11 @@
+*                               @markus-oberhumer @jreiser
+
+/src/p_elf*                     @jreiser
+/src/p_lx_*                     @jreiser
+/src/p_mach*                    @jreiser
+/src/p_unix*                    @jreiser
+/src/p_vmlin*                   @jreiser
+
+/src/stub/src/*bsd.*            @jreiser
+/src/stub/src/*darwin.*         @jreiser
+/src/stub/src/*linux.*          @jreiser

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+This issue tracker is **ONLY** used for reporting bugs.
+Please use [stackoverflow](https://stackoverflow.com) for supporting issues.
+
+<!---
+
+IF YOU REMOVE THIS TEMPLATE WE WILL CLOSE YOUR ISSUE WITHOUT RESPONSE.
+Just read it and fill in the details we're asking, it saves so much of our time. Thanks!
+
+-->
+
+## What's the problem (or question)?
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## What should have happened?
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Do you have an idea for a solution?
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## How can we reproduce the issue?
+<!--- Provide unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Please tell us details about your environment.
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* UPX version used (`upx --version`):
+* Host Operating System and version:
+* Host CPU architecture:
+* Target Operating System and version:
+* Target CPU architecture:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,45 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+This issue tracker is **ONLY** used for requesting sensible features.
+Please use [stackoverflow](https://stackoverflow.com) for supporting issues.
+
+<!---
+
+IF YOU REMOVE THIS TEMPLATE WE WILL CLOSE YOUR ISSUE WITHOUT RESPONSE.
+Just read it and fill in the details we're asking, it saves so much of our time. Thanks!
+
+-->
+
+## What's the problem (or question)?
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## What should have happened?
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Do you have an idea for a solution?
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## How can we reproduce the issue?
+<!--- Provide unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Please tell us details about your environment.
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* UPX version used (`upx --version`):
+* Host Operating System and version:
+* Host CPU architecture:
+* Target Operating System and version:
+* Target CPU architecture:

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      # Check for updates to GitHub Actions every Wednesday
+      interval: 'weekly'
+      day: 'wednesday'

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+UPX PULL REQUEST NOTES
+======================
+
+Handling pull requests is actually quite time consuming, so please
+
+- if you want to contribute **a real C++ code bug-fix** then open an issue
+on the main UPX issue tracker first
+
+- if you want to contribute **a new feature** then by all means open an issue
+on the main UPX issue tracker first before starting any coding!
+
+- please refuse the temptation to "improve" the docs, scripts, CI, makefiles,
+cmake build system, spelling errors, etc - we will NOT merge this; only open
+an issue if you're sure there is a **real bug**

.github/security.md

@@ -0,0 +1,15 @@
+# Security Context
+
+IMPORTANT NOTE: UPX inherits the security context of any files it handles.
+
+This means that packing, unpacking, or even testing or listing a file requires
+the same security considerations as actually executing the file.
+
+Use UPX on trusted files only!
+
+## Supported Versions
+
+| Version   | Supported          |
+| --------- | ------------------ |
+| git HEAD  | :white_check_mark: |
+| any other | :x:                |

.github/typos_config.toml

@@ -0,0 +1,42 @@
+# see https://github.com/crate-ci/typos
+
+# a generic spell-checker that works on source code is quite
+# tricky, so some false positives are fine
+
+[files]
+extend-exclude = ["LICENSE", "misc/*/packages.txt", "misc/*/*/packages.txt"]
+
+[default.extend-identifiers]
+# misc variable names & symbols
+acc_spawnve = "acc_spawnve"
+ba = "ba"
+fo = "fo"
+fof = "fof"
+O_WRONLY = "O_WRONLY"
+# clang-analyzer-optin.cplusplus
+optin = "optin"
+sidelen = "sidelen"
+tpos = "tpos"
+# assembly sources
+CArry = "CArry"
+hda = "hda"
+Larg = "Larg"
+pard = "pard"
+suble = "suble"
+
+# identifiers are intelligently split into words and then checked again
+[default.extend-words]
+delt = "delt"
+FO = "FO"
+fo = "fo"
+# parm is used like param
+PARM = "PARM"
+parm = "parm"
+# rela: ELF relocations
+RELA = "RELA"
+rela = "rela"
+# siz is used for size
+siz = "siz"
+# SEH: Structured Exception Handling
+SEH = "SEH"
+seh = "seh"

.github/workflows/ci.yml

@@ -0,0 +1,488 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+# note: GitHub Actions runner images are frequently updated, and
+# unfortunately this sometimes breaks builds in mysterious ways...
+# see https://github.com/actions/runner-images.git
+
+name: 'CI'
+
+on: [push, workflow_dispatch]
+
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+  UPX_CMAKE_BUILD_FLAGS: --verbose
+  # 2023-07-30
+  ZIG_DIST_VERSION: 0.11.0-dev.4320+6f0a613b6
+
+jobs:
+  job-rebuild-and-verify-stubs:
+    name: 'Rebuild stubs'
+    runs-on: ubuntu-20.04
+    steps:
+      - name: 'Install extra packages'
+        run: |
+          uname -a; pwd; id; umask
+          mkdir ../deps; cd ../deps; mkdir packages
+          if ! test -e /usr/bin/python2; then
+            ####sudo apt-get update && sudo apt-get install -y --no-install-recommends python2-minimal
+            # install python2-minimal packages from Debian-11
+            wget -q 'https://ftp.debian.org/debian/pool/main/p/python2.7/libpython2.7-minimal_2.7.18-8_amd64.deb'
+            wget -q 'https://ftp.debian.org/debian/pool/main/p/python2.7/python2.7-minimal_2.7.18-8_amd64.deb'
+            sudo dpkg -i ./*python2*.deb && rm ./*python2*.deb && sudo ldconfig
+            sudo ln -s -v python2.7 /usr/bin/python2
+          fi
+          # manually unpack and install compat libs from Ubuntu-16.04
+          wget -q 'https://archive.kernel.org/ubuntu-archive/ubuntu/pool/main/m/mpfr4/libmpfr4_3.1.6-1_amd64.deb'
+          for f in ./*.deb; do dpkg -x $f ./packages; done
+          sudo mv -v -n ./packages/usr/lib/x86_64-linux-gnu/lib* /usr/lib/x86_64-linux-gnu/
+          rm -rf ./*.deb ./packages
+          sudo ldconfig
+          # install upx-stubtools
+          wget -q -O - https://github.com/upx/upx-stubtools/releases/download/v20221212/bin-upx-20221212.tar.xz | tar -xJ
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Rebuild and verify stubs'
+        run: |
+          export PATH="$(readlink -en ../deps/bin-upx-20221212):$PATH"
+          make -C src/stub maintainer-clean extra-clean
+          git status || true
+          make -C src/stub extra-all all
+          if ! git diff --quiet; then git diff; exit 1; fi
+      - name: 'Check source code formatting'
+        run: |
+          bash ./misc/scripts/check_whitespace_git.sh
+          UPX_CLANG_FORMAT="$PWD/../deps/bin-upx-20221212/clang-format-15.0.6" make -C src clang-format
+          if ! git diff --quiet; then git diff; exit 1; fi
+
+  job-linux-cmake: # uses cmake + make
+    if: ${{ true }}
+    needs: [ job-rebuild-and-verify-stubs ]
+    name: ${{ format('{0} cmake', matrix.os) }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: ubuntu-22.04, use_m32: true }
+          - { os: ubuntu-20.04, use_m32: false } # use_m32 also works here, but save some CI time
+    steps:
+      - name: 'Install extra 32-bit and Windows packages'
+        if: ${{ matrix.use_m32 }}
+        run: |
+          sudo dpkg --add-architecture i386
+          sudo apt-get update
+          sudo apt-get install -y g++-multilib g++-mingw-w64-i686 g++-mingw-w64-x86-64
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Check out test suite'
+        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
+      - name: 'Build cmake extra/gcc/debug'
+        run:   'make build/extra/gcc/debug'
+      - name: 'Build cmake extra/gcc/release'
+        run:   'make build/extra/gcc/release'
+      - name: 'Build cmake extra/clang/debug'
+        run:   'make build/extra/clang/debug'
+      - name: 'Build cmake extra/clang/release'
+        run:   'make build/extra/clang/release'
+      - name: 'Build cmake extra/gcc-m32/debug'
+        if: ${{ matrix.use_m32 }}
+        run:   'make build/extra/gcc-m32/debug'
+      - name: 'Build cmake extra/gcc-m32/release'
+        if: ${{ matrix.use_m32 }}
+        run:   'make build/extra/gcc-m32/release'
+      - name: 'Build cmake extra/cross-windows-mingw32/release'
+        if: ${{ matrix.use_m32 }}
+        run:   'make build/extra/cross-windows-mingw32/release'
+      - name: 'Build cmake extra/cross-windows-mingw64/release'
+        if: ${{ matrix.use_m32 }}
+        run:   'make build/extra/cross-windows-mingw64/release'
+      - name: 'Make artifact'
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && shopt -s nullglob && cp -ai --parents */upx{,.exe} */*/*/upx{,.exe} "../tmp/artifact/$N")
+          (cd tmp/artifact && tar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run install tests'
+        run: |
+          (cd build/extra/gcc/release && DESTDIR=$PWD/Install-with-cmake cmake --install .)
+          (cd build/extra/gcc/release && DESTDIR=$PWD/Install-with-make  make install)
+      - name: 'Run basic tests'
+        run: |
+          make -C build/extra/gcc/debug test
+          make -C build/extra/gcc/release test
+          make -C build/extra/clang/debug test
+          make -C build/extra/clang/release test
+      - name: 'Run basic tests 32-bit'
+        if: ${{ matrix.use_m32 }}
+        run: |
+          make -C build/extra/gcc-m32/debug test
+          make -C build/extra/gcc-m32/release test
+      - name: 'Run test suite build/extra/gcc/release'
+        run: |
+          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
+          testsuite_1="$(readlink -en ./misc/testsuite/upx_testsuite_1.sh)"
+          env -C build/extra/gcc/release upx_exe=./upx bash "$testsuite_1"
+
+  job-macos-cmake: # uses cmake + make
+    if: ${{ true }}
+    needs: [ job-rebuild-and-verify-stubs ]
+    name: ${{ format('{0} cmake', matrix.os) }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: macos-11, gcc: gcc-10, gxx: 'g++-10', testsuite: true }
+          - { os: macos-12, gcc: gcc-11, gxx: 'g++-11', testsuite: true }
+          - { os: macos-13, gcc: gcc-12, gxx: 'g++-12', testsuite: true }
+    steps:
+      - name: 'Install brew packages'
+        if: ${{ matrix.testsuite }}
+        run: |
+          # testsuite needs working "readlink -en" and "sha256sum -b"
+          if ! test -e /usr/local/opt/coreutils/libexec/gnubin/readlink; then
+            echo "===== brew leaves:"; brew leaves; echo "===== brew list:"; brew list
+            # only run "brew update" if needed
+            if ! brew install coreutils; then brew update && brew install coreutils; fi
+          fi
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Check out test suite'
+        if: ${{ matrix.testsuite }}
+        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
+      - name: 'Build cmake extra/clang/debug'
+        run:   'make build/extra/clang/debug'
+      - name: 'Build cmake extra/clang/release'
+        run:   'make build/extra/clang/release'
+      - name: 'Build cmake extra/gcc/debug'
+        if: ${{ matrix.gcc != '' }}
+        run:   'make build/extra/gcc/debug CC="${{ matrix.gcc }} -static-libgcc" CXX="${{ matrix.gxx }} -static-libgcc -static-libstdc++"'
+      - name: 'Build cmake extra/gcc/release'
+        if: ${{ matrix.gcc != '' }}
+        run:   'make build/extra/gcc/release CC="${{ matrix.gcc }} -static-libgcc" CXX="${{ matrix.gxx }} -static-libgcc -static-libstdc++"'
+      - name: 'Build cmake xtarget/cross-darwin-arm64/debug'
+        run: |
+          CC="clang -target arm64-apple-darwin" CXX="clang++ -target arm64-apple-darwin" \
+          make UPX_XTARGET=cross-darwin-arm64 xtarget/debug
+      - name: 'Build cmake xtarget/cross-darwin-arm64/release'
+        run: |
+          CC="clang -target arm64-apple-darwin" CXX="clang++ -target arm64-apple-darwin" \
+          make UPX_XTARGET=cross-darwin-arm64 xtarget/release
+      - name: 'Make artifact'
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && rsync -R -a */*/*/upx "../tmp/artifact/$N/")
+          (cd tmp/artifact && gtar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run install tests'
+        run: |
+          (cd build/extra/clang/release && DESTDIR=$PWD/Install-with-cmake cmake --install .)
+          (cd build/extra/clang/release && DESTDIR=$PWD/Install-with-make  make install)
+      - name: 'Run basic tests'
+        if: ${{ !contains(matrix.os, 'macos-13') }} # FIXME: UPX on macos-13 is broken => disable self-test for now
+        run: |
+          make -C build/extra/clang/debug test
+          make -C build/extra/clang/release test
+      - name: 'Run test suite build/extra/clang/release'
+        if: ${{ matrix.testsuite }}
+        run: |
+          export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"
+          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
+          testsuite_1="$(readlink -en ./misc/testsuite/upx_testsuite_1.sh)"
+          env -C build/extra/clang/release upx_exe=./upx bash "$testsuite_1"
+
+  job-windows-cmake: # uses cmake + msbuild
+    if: ${{ true }}
+    needs: [ job-rebuild-and-verify-stubs ]
+    name: ${{ format('{0} cmake', matrix.name) }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # windows-2019 used to work but got broken with the 20220821.1 runner-image
+          # update; we cannot download that image for inspection, and debugging the
+          # remote image is painful, so disable for now
+          ####- { name: windows-2019-amd64, os: windows-2019, vsversion: 2019, arch: amd64 }
+          - { name: windows-2022-amd64, os: windows-2022, vsversion: 2022, arch: amd64 }
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Check out test suite'
+        run: 'git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite'
+      - name: 'Set up Developer Command Prompt'
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: ${{ matrix.vsversion }}
+          arch: ${{ matrix.arch }}
+      - name: 'Build cmake debug'
+        run:   'make build/debug'
+      - name: 'Build cmake release'
+        run:   'make build/release'
+      - name: 'Make artifact'
+        shell: bash
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-${{ matrix.os }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && cp -ai --parents */*/upx.exe "../tmp/artifact/$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run basic tests'
+        if: ${{ matrix.arch != 'amd64_arm64' }}
+        run: |
+          ctest --test-dir build/debug   -C Debug
+          ctest --test-dir build/release -C Release
+      - name: 'Run test suite build/release'
+        if: ${{ matrix.arch != 'amd64_arm64' }}
+        shell: bash
+        run: |
+          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
+          testsuite_1="$(readlink -en ./misc/testsuite/upx_testsuite_1.sh)"
+          env -C build/release/Release upx_exe=./upx bash "$testsuite_1"
+
+  job-windows-toolchains: # build "by hand" using cmd.exe
+    if: ${{ true }}
+    needs: [ job-rebuild-and-verify-stubs ]
+    name: ${{ format('windows {0}', matrix.name) }}
+    runs-on: ${{ matrix.os }}
+    env:
+      C: ${{ matrix.name }}
+      B: release
+      H: 'd:\a\upx\upx'
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { name: amd64-win64-vs2019,   os: windows-2019, vsversion: 2019, arch: amd64 }
+          - { name: amd64-win64-vs2022,   os: windows-2022, vsversion: 2022, arch: amd64 }
+          - { name: arm64-win64-vs2019,   os: windows-2019, vsversion: 2019, arch: amd64_arm64 }
+          - { name: arm64-win64-vs2022,   os: windows-2022, vsversion: 2022, arch: amd64_arm64 }
+          - { name: arm64ec-win64-vs2022, os: windows-2022, vsversion: 2022, arch: amd64_arm64, cl_machine_flags: -arm64EC, link_machine_flags: '/machine:arm64ec' }
+          # { name: arm64x-win64-vs2022,  os: windows-2022, vsversion: 2022, arch: amd64_arm64, cl_machine_flags: -arm64EC, link_machine_flags: '/machine:arm64x' }
+          - { name: i386-win32-vs2019,    os: windows-2019, vsversion: 2019, arch: amd64_x86 }
+          - { name: i386-win32-vs2022,    os: windows-2022, vsversion: 2022, arch: amd64_x86 }
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Prepare sources and Check out test suite'
+        shell: bash
+        run: |
+          git clone --depth=1 https://github.com/upx/upx-testsuite ../deps/upx-testsuite
+          mkdir -p -v build/$C/$B/{bzip2,ucl,upx,zlib,zstd}
+      - name: 'Set up Developer Command Prompt'
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: ${{ matrix.vsversion }}
+          arch: ${{ matrix.arch }}
+      - name: 'Build by hand'
+        shell: cmd
+        run: |
+          @REM ===== set vars =====
+          where cl & where link
+          set RUN_CL=cl ${{ matrix.cl_machine_flags }} -MT
+          set RUN_LIB=link -lib ${{ matrix.link_machine_flags }}
+          set DEFS=-D_CRT_NONSTDC_NO_WARNINGS -D_CRT_SECURE_NO_WARNINGS
+          set BDIR=%H%\build\%C%\%B%
+          git rev-parse --short=12 HEAD > %BDIR%\upx\.GITREV.txt
+          @REM ===== build bzip2 =====
+          cd %BDIR%\bzip2
+          @rem %RUN_CL% -J -O2 -W4 -wd4127 -wd4244 -wd4267 -WX %DEFS% -c %H%\vendor\bzip2\*.c
+          @rem %RUN_LIB% -out:bzip2.lib *.obj
+          @REM ===== build UCL =====
+          cd %BDIR%\ucl
+          set s=%H%\vendor\ucl
+          %RUN_CL% -J -O2 -W4 -WX %DEFS% -I%s%\include -I%s% -c %s%\src\*.c
+          %RUN_LIB% -out:ucl.lib *.obj
+          @REM ===== build zlib =====
+          cd %BDIR%\zlib
+          %RUN_CL% -J -O2 -W3 -WX %DEFS% -DHAVE_VSNPRINTF -c %H%\vendor\zlib\*.c
+          %RUN_LIB% -out:zlib.lib *.obj
+          @REM ===== build zstd =====
+          cd %BDIR%\zstd
+          set s=%H%\vendor\zstd\lib
+          @rem %RUN_CL% -J -O2 -W4 -WX %DEFS% -DDYNAMIC_BMI2=0 -DZSTD_DISABLE_ASM -c %s%\common\*.c %s%\compress\*.c %s%\decompress\*.c
+          @rem %RUN_LIB% -out:zstd.lib *.obj
+          @REM ===== build UPX =====
+          cd %BDIR%\upx
+          set s=%H%\src
+          cat .GITREV.txt
+          set /p GITREV=<.GITREV.txt
+          set UPX_DEFS=-DUPX_CONFIG_DISABLE_WSTRICT=0 -DUPX_CONFIG_DISABLE_WERROR=0 -DWITH_BZIP2=0 -DWITH_ZSTD=0
+          set UPX_LIBS=%BDIR%\ucl\ucl.lib %BDIR%\zlib\zlib.lib
+          @rem set UPX_LIBS=%BDIR%\bzip2\bzip2.lib %BDIR%\ucl\ucl.lib %BDIR%\zlib\zlib.lib %BDIR%\zstd\zstd.lib
+          set sources=%s%\*.cpp %s%\check\*.cpp %s%\compress\*.cpp %s%\console\*.cpp %s%\filter\*.cpp %s%\util\*.cpp
+          %RUN_CL% -J -O2 -W4 -WX -std:c++17 -Zc:__cplusplus -EHsc -DUPX_VERSION_GITREV="""%GITREV%""" %DEFS% %UPX_DEFS% -I%H%\vendor -Feupx.exe %sources% %UPX_LIBS% /link ${{ matrix.link_machine_flags }} setargv.obj
+      - name: 'Make artifact'
+        shell: bash
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-windows-${{ matrix.name }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N/$B"
+          cp -ai build/$C/$B/upx/upx*.exe "tmp/artifact/$N/$B"
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run basic tests'
+        if: ${{ matrix.arch != 'amd64_arm64' }}
+        run: |
+          $ErrorActionPreference = 'stop'
+          $ErrorView = 'NormalView'
+          cd $Env:H\build\$Env:C\$Env:B\upx
+          $Env:UPX = "--no-color --no-progress"
+          .\upx.exe --version
+          .\upx.exe upx.exe -o upx_packed.exe
+          dir *.exe
+          .\upx.exe -l upx_packed.exe
+          .\upx.exe -t upx_packed.exe
+          .\upx_packed.exe --version
+      - name: 'Run test suite'
+        if: ${{ matrix.arch != 'amd64_arm64' }}
+        shell: bash
+        run: |
+          export upx_testsuite_SRCDIR="$(readlink -en ../deps/upx-testsuite)"
+          testsuite_1="$(readlink -en ./misc/testsuite/upx_testsuite_1.sh)"
+          env -C build/$C/$B/upx upx_exe=./upx.exe bash "$testsuite_1"
+
+  job-linux-zigcc: # uses cmake + make
+    if: ${{ true }}
+    needs: [ job-rebuild-and-verify-stubs ]
+    name: ${{ format('zigcc {0} {1}', matrix.zig_target, matrix.zig_pic) }}
+    runs-on: ubuntu-latest
+    container: 'alpine:3.18' # older versions such as alpine:3.12 also work; no-container also works
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # only build a few targets => more targets are tested in the Weekly CI
+          - { zig_target: aarch64-linux-musl }
+          # { zig_target: aarch64-linux-musl, zig_pic: -fPIE }
+          # { zig_target: aarch64-macos-none }
+          - { zig_target: aarch64-macos.11.0-none }
+          # { zig_target: aarch64-macos.12.0-none }
+          # { zig_target: aarch64-macos.13.0-none }
+          - { zig_target: aarch64-windows-gnu }
+          - { zig_target: arm-linux-musleabihf }
+          # { zig_target: arm-linux-musleabihf, zig_pic: -fPIE }
+          # { zig_target: i386-linux-musl }
+          - { zig_target: i386-windows-gnu }
+          # { zig_target: mips-linux-musl }
+          # { zig_target: mipsel-linux-musl }
+          # { zig_target: powerpc-linux-musl }
+          # { zig_target: powerpc64-linux-musl }
+          # { zig_target: powerpc64le-linux-musl }
+          - { zig_target: x86_64-linux-musl }
+          # { zig_target: x86_64-linux-musl, zig_pic: -fPIE }
+          # { zig_target: x86_64-macos-none }
+          - { zig_target: x86_64-macos.11.0-none }
+          # { zig_target: x86_64-macos.12.0-none }
+          # { zig_target: x86_64-macos.13.0-none }
+          - { zig_target: x86_64-windows-gnu }
+    env:
+      # for zig-cc wrapper scripts (see below):
+      ZIG_CPPFLAGS: -DUPX_DOCTEST_CONFIG_MULTITHREADING
+      ZIG_FLAGS: ${{ matrix.zig_flags }}
+      ZIG_PIC: ${{ matrix.zig_pic }}
+      ZIG_TARGET: ${{ matrix.zig_target }}
+    steps:
+      - name: 'Install Alpine Linux container packages'
+        if: ${{ job.container }}
+        shell: sh
+        run: |
+          apk update && apk upgrade && apk add bash cmake file git make tar xz
+          # set PATH like in Ubuntu
+          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+          # this seems to be needed when running in a container (beause of UID mismatch??)
+          git config --global --add safe.directory '*'
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: ${{ format('Install Zig {0}', env.ZIG_DIST_VERSION) }}
+        shell: bash
+        run: |
+          # GitHub Actions magic: set "UPX_GITREV_SHORT" environment value for use in steps below
+          rev=$(git rev-parse --short=7 HEAD)
+          echo "UPX_GITREV_SHORT=$rev" >> $GITHUB_ENV
+          # update ZIG_TARGET (i386 => x86)
+          ZIG_TARGET=${ZIG_TARGET/i386-/x86-}
+          echo "ZIG_TARGET=$ZIG_TARGET" >> $GITHUB_ENV
+          # install zig; note that ~/.local/bin is included in the default $PATH on Ubuntu
+          mkdir -p -v ~/.local/bin
+          cd ~/.local/bin
+          ZIG_DIST_NAME=zig-linux-x86_64-${ZIG_DIST_VERSION}
+          wget -q https://ziglang.org/builds/${ZIG_DIST_NAME}.tar.xz
+          ls -l ${ZIG_DIST_NAME}.tar.xz
+          tar -xoJf ${ZIG_DIST_NAME}.tar.xz
+          rm ${ZIG_DIST_NAME}.tar.xz
+          ln -s -v ${ZIG_DIST_NAME}/zig zig
+          #echo "PATH=$PATH" && which zig
+          echo -n 'zig version: '; zig version
+          # create wrapper scripts (needed for CMake)
+          echo -e '#!/bin/sh\nexec zig ar "$@"' > zig-ar
+          echo -e '#!/bin/sh\nexec zig cc  -target $ZIG_TARGET $ZIG_PIC $ZIG_FLAGS $ZIG_CPPFLAGS $ZIG_CFLAGS   "$@"' > zig-cc
+          echo -e '#!/bin/sh\nexec zig c++ -target $ZIG_TARGET $ZIG_PIC $ZIG_FLAGS $ZIG_CPPFLAGS $ZIG_CXXFLAGS "$@"' > zig-cxx
+          echo -e '#!/bin/sh\nexec zig ranlib "$@"' > zig-ranlib
+          chmod +x zig-ar zig-cc zig-cxx zig-ranlib
+          ls -la; head zig-ar zig-cc zig-cxx zig-ranlib
+      - name: ${{ format('Build Release with zig-cc -target {0} {1}', env.ZIG_TARGET, env.ZIG_PIC) }}
+        run: |
+          mkdir -p build/zig/${ZIG_TARGET}${ZIG_PIC}/release
+          cd       build/zig/${ZIG_TARGET}${ZIG_PIC}/release
+          cmake ../../../.. -DCMAKE_BUILD_TYPE=Release -DCMAKE_AR=$HOME/.local/bin/zig-ar -DCMAKE_C_COMPILER=zig-cc -DCMAKE_CXX_COMPILER=zig-cxx -DCMAKE_RANLIB=$HOME/.local/bin/zig-ranlib $EXTRA_CMAKE_CONFIG_FLAGS_RELEASE
+          cmake --build . --config Release --parallel --verbose
+          file ./upx*
+      - name: ${{ format('Build Debug with zig-cc -target {0} {1}', env.ZIG_TARGET, env.ZIG_PIC) }}
+        run: |
+          mkdir -p build/zig/${ZIG_TARGET}${ZIG_PIC}/debug
+          cd       build/zig/${ZIG_TARGET}${ZIG_PIC}/debug
+          cmake ../../../.. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_AR=$HOME/.local/bin/zig-ar -DCMAKE_C_COMPILER=zig-cc -DCMAKE_CXX_COMPILER=zig-cxx -DCMAKE_RANLIB=$HOME/.local/bin/zig-ranlib $EXTRA_CMAKE_CONFIG_FLAGS_DEBUG
+          cmake --build . --config Debug --parallel --verbose
+          file ./upx*
+      - name: ${{ format('Make artifact from upx-{0}-{1}', github.ref_name, env.UPX_GITREV_SHORT) }}
+        shell: bash
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-zigcc-${{ matrix.zig_target }}${ZIG_PIC}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && shopt -s nullglob && cp -ai --parents */upx{,.exe} */*/*/upx{,.exe} "../tmp/artifact/$N")
+          (cd tmp/artifact && tar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run install tests'
+        if: ${{ contains(matrix.zig_target, '-linux') }}
+        run: |
+          (cd build/zig/${ZIG_TARGET}${ZIG_PIC}/release && DESTDIR=$PWD/Install-with-cmake cmake --install .)
+          (cd build/zig/${ZIG_TARGET}${ZIG_PIC}/release && DESTDIR=$PWD/Install-with-make  make install)
+
+# vim:set ts=2 sw=2 et:

.github/workflows/github-close-inactive-issues.yml

@@ -0,0 +1,38 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+# see https://docs.github.com/en/actions/managing-issues-and-pull-requests/closing-inactive-issues
+# see https://github.com/actions/stale
+
+# Automatically closing issues is far from perfect, but then we only
+# have limited resources and this approach favors issues that people
+# actually care about.
+#
+# also see:
+#   "Should I Stale or Should I Close? An Analysis of a Bot that Closes
+#    Abandoned Issues and Pull Request".
+#   https://igorwiese.com/images/papers/Paper_BotSE_19.pdf
+
+name: 'GitHub - Close inactive issues'
+on:
+  schedule: [cron: '50 3 * * 3'] # run weekly Wednesday 03:50 UTC
+  workflow_dispatch:
+jobs:
+  close-issues:
+    name: 'Close inactive issues'
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v8
+        with:
+          operations-per-run: 300
+          exempt-all-milestones: true
+          exempt-issue-labels: 'blocker,bug,enhancement,help wanted,regression'
+          days-before-stale: 60
+          days-before-close: 30
+          stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Please remove the stale label or add a comment or this issue will be closed in 30 days.'
+          stale-pr-message:       'This PR is stale because it has been open 60 days with no activity. Please remove the stale label or add a comment or this PR will be closed in 30 days.'
+          close-issue-message: 'This issue was closed because it has been stalled for 30 days with no activity. Please feel free to reopen.'
+          close-pr-message:       'This PR was closed because it has been stalled for 30 days with no activity. Please feel free to reopen.'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/github-close-pull-requests.yml

@@ -0,0 +1,17 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+name: 'GitHub - Close pull requests'
+on:
+  #pull_request:
+  workflow_dispatch:
+jobs:
+  close-pull-requests:
+    name: 'Close pull requests'
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: 'Close pull requests'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr list --repo='${{ github.repository }}' --state=open --json=number | jq '.[].number' | xargs -r -n1 -- gh pr close --repo='${{ github.repository }}'

.github/workflows/misc-spell-check.yml

@@ -0,0 +1,19 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# see https://github.com/crate-ci/typos
+
+name: 'Misc - Spell check'
+on:
+  workflow_dispatch:
+env:
+  DEBIAN_FRONTEND: noninteractive
+jobs:
+  job-spell-check:
+    name: 'Spell check'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: false }
+      - name: 'Spell check with crate-ci/typos'
+        uses: crate-ci/typos@master
+        with: { config: ./.github/typos_config.toml }

.github/workflows/static-analyzer-clang-analyzer.yml

@@ -0,0 +1,30 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+name: 'Static Analyzer - clang-analyzer'
+on:
+  schedule: [cron: '10 5 * * 3'] # run weekly Wednesday 05:10 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-analyze-clang-analyzer: # uses cmake + make
+    strategy:
+      fail-fast: false
+      matrix: {container: ['alpine:3.16','alpine:3.17','alpine:3.18','alpine:edge','i386/alpine:edge']}
+    name: ${{ format('Analyze {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    steps:
+      - name: ${{ format('Install packages {0}', matrix.container) }}
+        run: 'apk update && apk upgrade && apk add clang clang-analyzer cmake g++ git make'
+      - name: ${{ format('Check out UPX {0} source code', github.ref_name) }}
+        run: |
+          git clone --branch "$GITHUB_REF_NAME" --depth 1 https://github.com/upx/upx
+          git -C upx submodule update --init
+      - name: 'Perform clang-analyzer scan-build Analysis Debug'
+        run: 'make -C upx build/analyze/clang-analyzer/debug'
+      - name: 'Perform clang-analyzer scan-build Analysis Release'
+        if: success() || failure() # run this step even if the previous step failed
+        run: 'make -C upx build/analyze/clang-analyzer/release'

.github/workflows/static-analyzer-clang-tidy.yml

@@ -0,0 +1,30 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+name: 'Static Analyzer - clang-tidy'
+on:
+  schedule: [cron: '30 5 * * 3'] # run weekly Wednesday 05:30 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-analyze-clang-tidy: # uses cmake + make
+    strategy:
+      fail-fast: false
+      matrix: {container: ['alpine:edge','i386/alpine:edge']}
+    name: ${{ format('Analyze clang-tidy {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    steps:
+      - name: ${{ format('Install packages {0}', matrix.container) }}
+        run: 'apk update && apk upgrade && apk add clang clang-extra-tools cmake g++ git make python3'
+      - name: ${{ format('Check out UPX {0} source code', github.ref_name) }}
+        run: |
+          git clone --branch "$GITHUB_REF_NAME" --depth 1 https://github.com/upx/upx
+          git -C upx submodule update --init
+      - name: 'Perform clang-tidy Analysis Debug'
+        run: 'make -k -C upx build/analyze/clang-tidy/debug'
+      - name: 'Perform clang-tidy Analysis Release'
+        if: success() || failure() # run this step even if the previous step failed
+        run: 'make -k -C upx build/analyze/clang-tidy/release'

.github/workflows/static-analyzer-codeql.yml

@@ -0,0 +1,34 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+name: 'Static Analyzer - CodeQL'
+on:
+  schedule: [cron: '50 5 * * 3'] # run weekly Wednesday 05:50 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-analyze-codeql:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'cpp' ]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/test-alpine-linux.yml

@@ -0,0 +1,135 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# test minimal number of packages required for building UPX under Alpine Linux
+#   clang: apk add clang cmake make
+#   gcc:   apk add cmake g++ make
+
+name: 'Test - Minimal Alpine build'
+on: [workflow_dispatch]
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-alpine-clang: # uses cmake + make
+    strategy: { matrix: { container: ['alpine:edge','i386/alpine:edge'] } }
+    name: ${{ format('clang {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    steps:
+      - name: ${{ format('Build clang {0}', matrix.container) }}
+        run: |
+          apk update && apk upgrade && apk add clang cmake make
+          wget https://github.com/upx/upx/releases/download/v4.0.2/upx-4.0.2-src.tar.xz
+          tar -xoaf upx-*-src.tar.xz
+          cd upx-*-src
+          make    build/debug   CC="clang -static" CXX="clang++ -static"
+          make    build/release CC="clang -static" CXX="clang++ -static"
+          make -C build/debug   test
+          make -C build/release test
+          make -C build/release install DESTDIR="$PWD/Install"
+          N=$(echo "upx-test-alpine-linux-clang-${{ matrix.container }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        if: ${{ !startsWith(matrix.container, 'i386/') }} # i386: missing nodejs on host
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: 'upx*/build/*/upx'
+
+  job-alpine-gcc: # uses cmake + make
+    strategy: { matrix: { container: ['alpine:edge','i386/alpine:edge'] } }
+    name: ${{ format('gcc {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    steps:
+      - name: ${{ format('Build gcc {0}', matrix.container) }}
+        run: |
+          apk update && apk upgrade && apk add cmake g++ make
+          wget https://github.com/upx/upx/releases/download/v4.0.2/upx-4.0.2-src.tar.xz
+          tar -xoaf upx-*-src.tar.xz
+          cd upx-*-src
+          make    build/debug   CC="gcc -static" CXX="g++ -static"
+          make    build/release CC="gcc -static" CXX="g++ -static"
+          make -C build/debug   test
+          make -C build/release test
+          make -C build/release install DESTDIR="$PWD/Install"
+          N=$(echo "upx-test-alpine-linux-gcc-${{ matrix.container }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        if: ${{ !startsWith(matrix.container, 'i386/') }} # i386: missing nodejs on host
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: 'upx*/build/*/upx'
+
+  job-alpine-by-hand: # uses a POSIX-compliant shell
+    # ...and also uses a subdirectory "upx with space" in order to detect possible quoting issues
+    # ...and also uses ccache as we are running the same build-script again and again
+    if: ${{ true }}
+    strategy: { matrix: { container: ['alpine:3.9','alpine:edge'] } }
+    name: ${{ format('gcc by-hand {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    steps:
+      - name: ${{ format('Install packages {0}', matrix.container) }}
+        run: |
+          # install ccache, g++, git and various POSIX shells
+          shells="bash dash loksh mksh zsh"
+          case ${{ matrix.container }} in
+            *:edge) shells="$shells oksh yash" ;;
+          esac
+          echo "installing shells: $shells"
+          apk update && apk upgrade && apk add ccache g++ git $shells
+          # enable ccache
+          echo -e "CC=ccache gcc\nCXX=ccache g++ -std=gnu++17" >> $GITHUB_ENV
+          # this seems to be needed when running in a container (beause of UID mismatch??)
+          git config --global --add safe.directory '*'
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+          path: 'upx with space'
+      - name: 'Build by-hand with bash'
+        run: 'bash "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with bash --posix'
+        run: 'bash --posix "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with busybox ash'
+        run: 'busybox ash "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with busybox sh'
+        run: 'busybox sh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with dash'
+        run: 'dash "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with loksh'
+        run: 'ksh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with loksh -o posix'
+        run: 'ksh -o posix "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with loksh -o sh'
+        run: 'ksh -o sh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with mksh'
+        run: 'mksh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with mksh -o posix'
+        run: 'mksh -o posix "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with mksh -o sh'
+        run: 'mksh -o sh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with oksh'
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: 'oksh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with oksh -o posix'
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: 'oksh -o posix "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with oksh -o sh'
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: 'oksh -o sh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with yash'
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: 'yash "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with zsh'
+        run: 'zsh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with zsh --emulate ksh'
+        run: 'zsh --emulate ksh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Build by-hand with zsh --emulate sh'
+        run: 'zsh --emulate sh "./upx with space/misc/scripts/build_upx_by_hand.sh"'
+      - name: 'Show ccache stats'
+        run: |
+          ccache -s
+          ccache -p

.github/workflows/test-cmake-default.yml

@@ -0,0 +1,132 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+name: 'Test - CMake default build type'
+on: [workflow_dispatch]
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+
+#
+# single-config generators - these use and respect CMAKE_BUILD_TYPE
+#
+
+  cmake-make:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Config, build, test and install'
+        run: |
+          cmake -S . -B build/default -G "Unix Makefiles"
+          cmake --build build/default --parallel --verbose
+          ctest --test-dir build/default
+          (cd build/default && DESTDIR=$PWD/Install-default cmake --install .)
+          # "make test" also works
+          env -C build/default make test
+          # "make install" also works
+          env -C build/default DESTDIR=./Install-with-make make install
+
+  cmake-ninja:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Config, build, test and install'
+        run: |
+          test -f /usr/bin/ninja || sudo apt-get install -y ninja-build
+          cmake -S . -B build/default -G Ninja
+          cmake --build build/default --parallel --verbose
+          ctest --test-dir build/default
+          (cd build/default && DESTDIR=$PWD/Install-default cmake --install .)
+          # "ninja test" also works
+          env -C build/default ninja test
+          # "ninja install" also works
+          env -C build/default DESTDIR=./Install-with-ninja ninja install
+
+  cmake-nmake:
+    runs-on: windows-2022
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Set up Developer Command Prompt'
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: 2022
+          arch: amd64
+      - name: 'Config, build, test and install'
+        run: |
+          cmake -S . -B build/default -G "NMake Makefiles"
+          cmake --build build/default --parallel --verbose
+          ctest --test-dir build/default
+          # "cmake --install" works on Windows as well, nice
+          env -C build/default DESTDIR=./Install-default cmake --install .
+          # "nmake test" also works
+          env -C build/default nmake test
+          # "nmake install" also works
+          env -C build/default DESTDIR=./Install-with-nmake nmake install
+
+#
+# multi-config generators - these use CMAKE_CONFIGURATION_TYPES, but the defaults seem inconsistent
+#   => when using multi-config generators always explicitly pass the requested build-config
+#
+
+  # ninja-multi-config seems to use the *first* element of CMAKE_CONFIGURATION_TYPES; nice
+  cmake-ninja-multi-config:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Config, build, test and install'
+        run: |
+          test -f /usr/bin/ninja || sudo apt-get install -y ninja-build
+          cmake -S . -B build/default -G "Ninja Multi-Config"
+          cmake --build build/default --parallel --verbose
+          # multi-config: ctest NEEDS a config
+          ctest --test-dir build/default -C Release
+          (cd build/default && DESTDIR=$PWD/Install-default cmake --install .)
+          # "ninja test" also works with multi-config
+          env -C build/default ninja test
+          # "ninja install" also works with multi-config
+          env -C build/default DESTDIR=./Install-with-ninja ninja install
+
+  # vsstudio-multi-config (msbuild) seems to use "Debug" by default
+  cmake-vsstudio-multi-config:
+    runs-on: windows-2022
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Set up Developer Command Prompt'
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: 2022
+          arch: amd64
+      - name: 'Config, build and test'
+        run: |
+          cmake -S . -B build/default
+          cmake --build build/default --parallel --verbose
+          # multi-config: ctest NEEDS a config
+          ctest --test-dir build/default -C Debug
+          # TODO: does cmake --install work?
+
+  # xcode-multi-config (xcodebuild) seems to use "Debug" by default, except for "cmake --install" (BUG?)
+  cmake-xcode-multi-config:
+    runs-on: macos-12
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Config, build, test and install'
+        run: |
+          cmake -S . -B build/default -G Xcode
+          cmake --build build/default --parallel --verbose
+          # multi-config: ctest NEEDS a config
+          ctest --test-dir build/default -C Debug
+          # BUG(?) multi-config: cmake --install defaults to "Release" !!
+          (cd build/default && DESTDIR=$PWD/Install-default cmake --install . --config Debug)

.github/workflows/weekly-ci-alpine-linux.yml

@@ -0,0 +1,156 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# Build under various Alpine Linux versions with clang and gcc, and
+# also test building with C++20 and C++23.
+
+# And also uses a subdirectory "upx with space" that contains whitespace in order
+# to detect possible quoting issues.
+
+# info: Alpine 3.9 has clang-5, cmake-3.13.0 and gcc-8, which nicely
+#   matches our minimal build requirements
+
+name: 'Weekly CI - Alpine Linux'
+on:
+  schedule: [cron: '05 4 * * 3'] # run weekly Wednesday 04:05 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+  UPX_TESTSUITE_LEVEL: 2
+
+jobs:
+  job-alpine-cmake: # uses cmake + make
+    strategy:
+      fail-fast: false
+      matrix: { container: ['alpine:3.9','alpine:3.10','alpine:3.11','alpine:3.12','alpine:3.13','alpine:3.14','alpine:3.15','alpine:3.16','alpine:3.17','alpine:3.18','alpine:edge','i386/alpine:edge'] }
+    name: ${{ format('container {0}', matrix.container) }}
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    env: { UPX_CMAKE_CONFIG_FLAGS: '-DCMAKE_VERBOSE_MAKEFILE=ON' }
+    steps:
+      - name: ${{ format('Install packages {0}', matrix.container) }}
+        run: |
+          apk update && apk upgrade && apk add clang cmake g++ git make
+          case ${{ matrix.container }} in
+            # clang-dev is needed on older Alpine versions for clang headers like <emmintrin.h>
+            *:3.[0-9]|*:3.10|*:3.11) apk add clang-dev ;;
+          esac
+      - name: ${{ format('Check out UPX {0} source code', github.ref_name) }}
+        run: |
+          git clone --branch "$GITHUB_REF_NAME" --depth 1 https://github.com/upx/upx "upx with space"
+          git -C "upx with space" submodule update --init
+          x="$(apk list -I "$(apk info -Wq "$(which clang)")")"; echo "clang_package=${x%% *}" >> $GITHUB_ENV
+          x="$(apk list -I "$(apk info -Wq "$(which gcc)")")"; echo "gcc_package=${x%% *}" >> $GITHUB_ENV
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-weekly-ci-alpine-${{ matrix.container }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          echo "artifact_name=$N" >> $GITHUB_ENV
+
+      # build with default C11 and C++17
+      - name: ${{ format('Build clang Release with {0}', env.clang_package) }}
+        run: 'make -C "upx with space" UPX_XTARGET=clang-static CC="clang -static" CXX="clang++ -static"'
+      - name: ${{ format('Build clang Debug with {0}', env.clang_package) }}
+        run: 'make -C "upx with space" UPX_XTARGET=clang-static CC="clang -static" CXX="clang++ -static" xtarget/debug'
+      - name: ${{ format('Build gcc Release with {0}', env.gcc_package) }}
+        run: 'make -C "upx with space" UPX_XTARGET=gcc-static   CC="gcc -static"   CXX="g++ -static"'
+      - name: ${{ format('Build gcc Debug with {0}', env.gcc_package) }}
+        run: 'make -C "upx with space" UPX_XTARGET=gcc-static   CC="gcc -static"   CXX="g++ -static" xtarget/debug'
+
+      - name: 'Update environment'
+        run: |
+          echo "UPX_CONFIG_DISABLE_C_STANDARD=ON" >> $GITHUB_ENV
+          echo "UPX_CONFIG_DISABLE_CXX_STANDARD=ON" >> $GITHUB_ENV
+
+      # build with C17 and C++20 on alpine:edge
+      - name: ${{ format('Build clang C++20 Release with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxx20-static CC="clang -std=gnu17 -static" CXX="clang++ -std=gnu++20 -static"
+      - name: ${{ format('Build clang C++20 Debug with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxx20-static CC="clang -std=gnu17 -static" CXX="clang++ -std=gnu++20 -static" xtarget/debug
+      - name: ${{ format('Build gcc C++20 Release with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxx20-static   CC="gcc -std=gnu17 -static"   CXX="g++ -std=gnu++20 -static"
+      - name: ${{ format('Build gcc C++20 Debug with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxx20-static   CC="gcc -std=gnu17 -static"   CXX="g++ -std=gnu++20 -static" xtarget/debug
+
+      # build with C23 and C++23 on alpine:edge
+      - name: ${{ format('Build clang C++23 Release with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxx23-static CC="clang -std=gnu2x -static" CXX="clang++ -std=gnu++2b -static"
+      - name: ${{ format('Build clang C++23 Debug with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxx23-static CC="clang -std=gnu2x -static" CXX="clang++ -std=gnu++2b -static" xtarget/debug
+      - name: ${{ format('Build gcc C++23 Release with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxx23-static   CC="gcc -std=gnu2x -static"   CXX="g++ -std=gnu++23 -static"
+      - name: ${{ format('Build gcc C++23 Debug with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxx23-static   CC="gcc -std=gnu2x -static"   CXX="g++ -std=gnu++23 -static" xtarget/debug
+
+      # build with -flto=auto on alpine:edge
+      - name: ${{ format('Build clang LTO Release with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxxlto-static CC="clang -flto=auto -static" CXX="clang++ -flto=auto -static"
+      - name: ${{ format('Build clang LTO Debug with {0}', env.clang_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=clang-cxxlto-static CC="clang -flto=auto -static" CXX="clang++ -flto=auto -static" xtarget/debug
+      - name: ${{ format('Build gcc LTO Release with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxxlto-static   CC="gcc -flto=auto -static"   CXX="g++ -flto=auto -static"
+      - name: ${{ format('Build gcc LTO Debug with {0}', env.gcc_package) }}
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          make -C "upx with space" UPX_XTARGET=gcc-cxxlto-static   CC="gcc -flto=auto -static"   CXX="g++ -flto=auto -static" xtarget/debug
+
+      - { name: 'Strip release binaries', run: 'strip -p --strip-unneeded "upx with space"/build/*/*/release/upx' }
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        if: ${{ !startsWith(matrix.container, 'i386/') }} # i386: missing nodejs on host
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: 'upx with space*/build/*/*/*/upx'
+
+      - { name: 'Run basic tests clang Release', run: 'make -C "upx with space"/build/xtarget/clang-static/release test' }
+      - { name: 'Run basic tests clang Debug',   run: 'make -C "upx with space"/build/xtarget/clang-static/debug test' }
+      - { name: 'Run basic tests gcc Release',   run: 'make -C "upx with space"/build/xtarget/gcc-static/release test' }
+      - { name: 'Run basic tests gcc Debug',     run: 'make -C "upx with space"/build/xtarget/gcc-static/debug test' }
+      - name: 'Run basic tests C++20, C++23 and LTO'
+        if: ${{ contains(matrix.container, ':edge') }}
+        run: |
+          for dir in "upx with space"/build/xtarget/*-cxx*/*; do
+             echo "===== $dir"
+             make -C "$dir" test
+          done
+      - name: 'Run install tests'
+        run: |
+          (cd "upx with space"/build/xtarget/clang-static/debug   && DESTDIR="$PWD/Install with cmake" cmake --install .)
+          (cd "upx with space"/build/xtarget/clang-static/debug   && DESTDIR="$PWD/Install with make"  make install)
+          (cd "upx with space"/build/xtarget/clang-static/release && DESTDIR="$PWD/Install with cmake" cmake --install .)
+          (cd "upx with space"/build/xtarget/clang-static/release && DESTDIR="$PWD/Install with make"  make install)
+          (cd "upx with space"/build/xtarget/gcc-static/debug     && DESTDIR="$PWD/Install with cmake" cmake --install .)
+          (cd "upx with space"/build/xtarget/gcc-static/debug     && DESTDIR="$PWD/Install with make"  make install)
+          (cd "upx with space"/build/xtarget/gcc-static/release   && DESTDIR="$PWD/Install with cmake" cmake --install .)
+          (cd "upx with space"/build/xtarget/gcc-static/release   && DESTDIR="$PWD/Install with make"  make install)
+
+      # test suite
+      - name: ${{ format('Run test suite level {0}', env.UPX_TESTSUITE_LEVEL) }}
+        run: |
+          # use a directory that contains whitespace to detect possible quoting issues
+          git clone --depth=1 https://github.com/upx/upx-testsuite "upx-testsuite with space"
+          export upx_testsuite_SRCDIR="$(readlink -fn "upx-testsuite with space")"
+          testsuite_1="$(readlink -fn "upx with space"/misc/testsuite/upx_testsuite_1.sh)"
+          # testsuite needs bash and working "readlink -en" and "sha256sum -b"
+          apk add bash coreutils
+          (cd "upx with space"/build/xtarget/gcc-static/release && upx_exe=./upx bash "$testsuite_1")
+
+# vim:set ts=2 sw=2 et:

.github/workflows/weekly-ci-cmake-macos-xcode.yml

@@ -0,0 +1,54 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# build with 'cmake -G Xcode'
+
+name: 'Weekly CI - cmake macOS Xcode'
+on:
+  schedule: [cron: '20 4 * * 3'] # run weekly Wednesday 04:20 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-cmake-macos-xcode: # uses cmake + xcodebuild
+    name: ${{ format('{0} cmake Xcode', matrix.os) }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: macos-11, run_test: true }
+          - { os: macos-12, run_test: true }
+          - { os: macos-13, run_test: false } # TODO: enable once UPX fully works on macos-13
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - { name: 'Config cmake Xcode',        run: 'cmake -S . -B build/xcode -G Xcode' }
+      - { name: 'Build cmake Xcode default', run: 'cmake --build build/xcode' }
+      - { name: 'Build cmake Xcode Debug',   run: 'cmake --build build/xcode --config Debug' }
+      - { name: 'Build cmake Xcode Release', run: 'cmake --build build/xcode --config Release' }
+      - name: 'Make artifact'
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-weekly-ci-xcode-${{ matrix.os }}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && rsync -R -a */*/upx "../tmp/artifact/$N/")
+          (cd tmp/artifact && gtar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run basic tests'
+        if: ${{ matrix.run_test }}
+        run: |
+          ctest --test-dir build/xcode -C Debug
+          ctest --test-dir build/xcode -C Release
+      - name: 'Run install tests'
+        run: |
+          (cd build/xcode && DESTDIR=$PWD/Install-default cmake --install .)
+          (cd build/xcode && DESTDIR=$PWD/Install-debug   cmake --install . --config Debug)
+          (cd build/xcode && DESTDIR=$PWD/Install-release cmake --install . --config Release)
+          ls -l build/xcode/Install-*/usr/local/bin/upx

.github/workflows/weekly-ci-cmake-windows-nmake.yml

@@ -0,0 +1,76 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# build with 'cmake -G "NMake Makefiles"'
+
+name: 'Weekly CI - cmake Windows NMake'
+on:
+  schedule: [cron: '30 4 * * 3'] # run weekly Wednesday 04:30 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+
+jobs:
+  job-cmake-windows-nmake: # uses cmake + nmake
+    name: ${{ format('vs{0} {1} {2}', matrix.vsversion, matrix.arch, matrix.clang_cl && 'clang-cl' || '') }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # msvc
+          - { os: windows-2019, vsversion: 2019, arch: amd64 }
+          - { os: windows-2019, vsversion: 2019, arch: amd64_arm64 }
+          - { os: windows-2019, vsversion: 2019, arch: amd64_x86 }
+          - { os: windows-2022, vsversion: 2022, arch: amd64 }
+          - { os: windows-2022, vsversion: 2022, arch: amd64_arm64 }
+          - { os: windows-2022, vsversion: 2022, arch: amd64_x86 }
+          # clang-cl
+          - { os: windows-2022, vsversion: 2022, arch: amd64, clang_cl: true }
+    steps:
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: 'Set up Developer Command Prompt'
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          vsversion: ${{ matrix.vsversion }}
+          arch: ${{ matrix.arch }}
+      - name: 'Build cmake NMake Debug'
+        shell: cmd
+        run: |
+          set X=${{ matrix.clang_cl && '-DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl' || '' }}
+          cmake -S . -B build/debug -G "NMake Makefiles" -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_BUILD_TYPE=Debug %X%
+          cd build/debug
+          nmake
+          dir *.exe
+      - name: 'Build cmake NMake Release'
+        shell: cmd
+        run: |
+          set X=${{ matrix.clang_cl && '-DCMAKE_C_COMPILER=clang-cl -DCMAKE_CXX_COMPILER=clang-cl' || '' }}
+          cmake -S . -B build/release -G "NMake Makefiles" -DCMAKE_VERBOSE_MAKEFILE=ON %X%
+          cd build/release
+          nmake
+          dir *.exe
+      - name: 'Make artifact'
+        shell: bash
+        run: |
+          X="${{ matrix.clang_cl && '-clang-cl' || '' }}"
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-weekly-ci-nmake-vs${{ matrix.vsversion }}-${{ matrix.arch }}$X" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && cp -ai --parents */upx.exe "../tmp/artifact/$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run basic tests'
+        if: ${{ matrix.arch != 'amd64_arm64' }}
+        run: |
+          ctest --test-dir build/debug
+          ctest --test-dir build/release
+      - name: 'Run install tests'
+        run: |
+          env DESTDIR=./Install-debug   cmake --install build/debug
+          env DESTDIR=./Install-release cmake --install build/release

.github/workflows/weekly-ci-zigcc.yml

@@ -0,0 +1,126 @@
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+# build with "zig cc"; see https://ziglang.org/download/
+
+name: 'Weekly CI - zigcc'
+on:
+  schedule: [cron: '40 4 * * 3'] # run weekly Wednesday 04:40 UTC
+  workflow_dispatch:
+env:
+  CMAKE_REQUIRED_QUIET: OFF
+  DEBIAN_FRONTEND: noninteractive
+  # 2023-07-30
+  ZIG_DIST_VERSION: 0.11.0-dev.4320+6f0a613b6
+
+jobs:
+  job-linux-zigcc: # uses cmake + make
+    name: ${{ format('zigcc {0} {1}', matrix.zig_target, matrix.zig_pic) }}
+    runs-on: ubuntu-latest
+    container: 'alpine:3.18' # older versions such as alpine:3.12 also work; no-container also works
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { zig_target: aarch64-linux-musl }
+          - { zig_target: aarch64-linux-musl, zig_pic: -fPIE }
+          - { zig_target: aarch64-macos-none }
+          - { zig_target: aarch64-macos.11.0-none }
+          - { zig_target: aarch64-macos.12.0-none }
+          - { zig_target: aarch64-macos.13.0-none }
+          - { zig_target: aarch64-windows-gnu }
+          - { zig_target: arm-linux-musleabihf }
+          - { zig_target: arm-linux-musleabihf, zig_pic: -fPIE }
+          - { zig_target: i386-linux-musl }
+          - { zig_target: i386-windows-gnu }
+          - { zig_target: mips-linux-musl }
+          - { zig_target: mipsel-linux-musl }
+          - { zig_target: powerpc-linux-musl }
+          - { zig_target: powerpc64-linux-musl }
+          - { zig_target: powerpc64le-linux-musl }
+          - { zig_target: x86_64-linux-musl }
+          - { zig_target: x86_64-linux-musl, zig_pic: -fPIE }
+          - { zig_target: x86_64-macos-none }
+          - { zig_target: x86_64-macos.11.0-none }
+          - { zig_target: x86_64-macos.12.0-none }
+          - { zig_target: x86_64-macos.13.0-none }
+          - { zig_target: x86_64-windows-gnu }
+    env:
+      # for zig-cc wrapper scripts (see below):
+      ZIG_CPPFLAGS: -DUPX_DOCTEST_CONFIG_MULTITHREADING
+      ZIG_FLAGS: ${{ matrix.zig_flags }}
+      ZIG_PIC: ${{ matrix.zig_pic }}
+      ZIG_TARGET: ${{ matrix.zig_target }}
+    steps:
+      - name: 'Install Alpine Linux container packages'
+        if: ${{ job.container }}
+        shell: sh
+        run: |
+          apk update && apk upgrade && apk add bash cmake file git make tar xz
+          # set PATH like in Ubuntu
+          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
+          # this seems to be needed when running in a container (beause of UID mismatch??)
+          git config --global --add safe.directory '*'
+      - name: 'Check out code'
+        uses: actions/checkout@v3
+        with: { submodules: true }
+      - name: ${{ format('Install Zig {0}', env.ZIG_DIST_VERSION) }}
+        shell: bash
+        run: |
+          # GitHub Actions magic: set "UPX_GITREV_SHORT" environment value for use in steps below
+          rev=$(git rev-parse --short=7 HEAD)
+          echo "UPX_GITREV_SHORT=$rev" >> $GITHUB_ENV
+          # update ZIG_TARGET (i386 => x86)
+          ZIG_TARGET=${ZIG_TARGET/i386-/x86-}
+          echo "ZIG_TARGET=$ZIG_TARGET" >> $GITHUB_ENV
+          # install zig; note that ~/.local/bin is included in the default $PATH on Ubuntu
+          mkdir -p -v ~/.local/bin
+          cd ~/.local/bin
+          ZIG_DIST_NAME=zig-linux-x86_64-${ZIG_DIST_VERSION}
+          wget -q https://ziglang.org/builds/${ZIG_DIST_NAME}.tar.xz
+          ls -l ${ZIG_DIST_NAME}.tar.xz
+          tar -xoJf ${ZIG_DIST_NAME}.tar.xz
+          rm ${ZIG_DIST_NAME}.tar.xz
+          ln -s -v ${ZIG_DIST_NAME}/zig zig
+          #echo "PATH=$PATH" && which zig
+          echo -n 'zig version: '; zig version
+          # create wrapper scripts (needed for CMake)
+          echo -e '#!/bin/sh\nexec zig ar "$@"' > zig-ar
+          echo -e '#!/bin/sh\nexec zig cc  -target $ZIG_TARGET $ZIG_PIC $ZIG_FLAGS $ZIG_CPPFLAGS $ZIG_CFLAGS   "$@"' > zig-cc
+          echo -e '#!/bin/sh\nexec zig c++ -target $ZIG_TARGET $ZIG_PIC $ZIG_FLAGS $ZIG_CPPFLAGS $ZIG_CXXFLAGS "$@"' > zig-cxx
+          echo -e '#!/bin/sh\nexec zig ranlib "$@"' > zig-ranlib
+          chmod +x zig-ar zig-cc zig-cxx zig-ranlib
+          ls -la; head zig-ar zig-cc zig-cxx zig-ranlib
+      - name: ${{ format('Build Release with zig-cc -target {0} {1}', env.ZIG_TARGET, env.ZIG_PIC) }}
+        run: |
+          mkdir -p build/zig/${ZIG_TARGET}${ZIG_PIC}/release
+          cd       build/zig/${ZIG_TARGET}${ZIG_PIC}/release
+          cmake ../../../.. -DCMAKE_BUILD_TYPE=Release -DCMAKE_AR=$HOME/.local/bin/zig-ar -DCMAKE_C_COMPILER=zig-cc -DCMAKE_CXX_COMPILER=zig-cxx -DCMAKE_RANLIB=$HOME/.local/bin/zig-ranlib $EXTRA_CMAKE_CONFIG_FLAGS_RELEASE
+          cmake --build . --config Release --parallel --verbose
+          file ./upx*
+      - name: ${{ format('Build Debug with zig-cc -target {0} {1}', env.ZIG_TARGET, env.ZIG_PIC) }}
+        run: |
+          mkdir -p build/zig/${ZIG_TARGET}${ZIG_PIC}/debug
+          cd       build/zig/${ZIG_TARGET}${ZIG_PIC}/debug
+          cmake ../../../.. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_AR=$HOME/.local/bin/zig-ar -DCMAKE_C_COMPILER=zig-cc -DCMAKE_CXX_COMPILER=zig-cxx -DCMAKE_RANLIB=$HOME/.local/bin/zig-ranlib $EXTRA_CMAKE_CONFIG_FLAGS_DEBUG
+          cmake --build . --config Debug --parallel --verbose
+          file ./upx*
+      - name: ${{ format('Make artifact from upx-{0}-{1}', github.ref_name, env.UPX_GITREV_SHORT) }}
+        shell: bash
+        run: |
+          N=$(echo "upx-${GITHUB_REF_NAME}-${GITHUB_SHA:0:7}-weekly-ci-zigcc-${{ matrix.zig_target }}${ZIG_PIC}" | sed 's/[^0-9a-zA-Z_.-]/-/g')
+          mkdir -p "tmp/artifact/$N"
+          (cd build && shopt -s nullglob && cp -ai --parents */upx{,.exe} */*/*/upx{,.exe} "../tmp/artifact/$N")
+          (cd tmp/artifact && tar --sort=name -czf "$N.tar.gz" "$N" && rm -rf "./$N")
+          # GitHub Actions magic: set "artifact_name" environment value for use in next step
+          echo "artifact_name=$N" >> $GITHUB_ENV
+      - name: ${{ format('Upload artifact {0}', env.artifact_name) }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.artifact_name }}
+          path: tmp/artifact
+      - name: 'Run install tests'
+        if: ${{ contains(matrix.zig_target, '-linux') }}
+        run: |
+          (cd build/zig/${ZIG_TARGET}${ZIG_PIC}/release && DESTDIR=$PWD/Install-with-cmake cmake --install .)
+          (cd build/zig/${ZIG_TARGET}${ZIG_PIC}/release && DESTDIR=$PWD/Install-with-make  make install)
+
+# vim:set ts=2 sw=2 et:

.gitignore

@@ -0,0 +1,54 @@
+/.hg*
+/.vscode*
+/Makevars.global*
+/Testing*
+/build*
+/maint*
+/vendor*
+
+GNUmakefile
+MMakefile
+Makevars.local*
+compile_flags.txt
+Tmp*
+tmp*
+
+*.a
+*.bz2
+*.d
+*.dll
+*.dylib
+*.exe
+*.gz
+*.lib
+*.map
+*.o
+*.obj
+*.out
+*.patch
+*.py[cdo]
+*.rar
+*.so
+*.swp
+*.tmp
+*.ttp
+*.xz
+*.zip
+*.zst
+
+doc/*.man
+doc/*.ps
+doc/*.tex
+
+src/stub/**/.*-stamp
+src/stub/tmp*/*.bin
+src/stub/tmp*/*.bin.bindump
+src/stub/tmp*/*.bin.disasm
+src/stub/tmp*/*.o.disasm
+src/stub/tmp*/mips.r3000-*.[is]
+src/stub/tmp*/mipsel.r3000-*.[is]
+src/stub/src/**/tmp*/*
+
+src/stub/tools/sstrip/amd64-linux-sstrip
+src/stub/tools/sstrip/i386-linux-sstrip
+src/stub/tools/sstrip/sstrip

.gitmodules

@@ -0,0 +1,25 @@
+[submodule "vendor/doctest"]
+    path = vendor/doctest
+    url = https://github.com/upx/upx-vendor-doctest.git
+    branch = upx-vendor
+    shallow = true
+[submodule "vendor/lzma-sdk"]
+    path = vendor/lzma-sdk
+    url = https://github.com/upx/upx-vendor-lzma-sdk.git
+    branch = upx-vendor
+    shallow = true
+[submodule "vendor/ucl"]
+    path = vendor/ucl
+    url = https://github.com/upx/upx-vendor-ucl.git
+    branch = upx-vendor
+    shallow = true
+[submodule "vendor/valgrind"]
+    path = vendor/valgrind
+    url = https://github.com/upx/upx-vendor-valgrind.git
+    branch = upx-vendor
+    shallow = true
+[submodule "vendor/zlib"]
+    path = vendor/zlib
+    url = https://github.com/upx/upx-vendor-zlib.git
+    branch = upx-vendor
+    shallow = true

CMakeLists.txt

@@ -0,0 +1,536 @@
+#
+# UPX "CMake" build file; see https://cmake.org/
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+#
+
+# Build requirements:
+#   A C++ compiler that fully implements C++17: clang-5, gcc-8 or msvc-2019-16.11
+#   (older or other compilers may work but are unsupported, use at your own risk)
+
+# CMake version check; using a somewhat current CMake version is highly recommended
+if(DEFINED UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION)
+    cmake_minimum_required(VERSION "${UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION}" FATAL_ERROR)
+else()
+    cmake_minimum_required(VERSION 3.8.0 FATAL_ERROR) # CMake >= 3.8 is needed for CXX_STANDARD 17
+endif()
+
+# compilation config options
+if(NOT IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.git")
+    # permissive config defaults when building from source code tarball
+    option(UPX_CONFIG_DISABLE_GITREV   "Do not compile with default Git version info." ON)
+    option(UPX_CONFIG_DISABLE_SANITIZE "Do not compile with default sanitize options." ON)
+    option(UPX_CONFIG_DISABLE_WSTRICT  "Do not compile with strict compiler warnings." ON)
+    option(UPX_CONFIG_DISABLE_WERROR   "Do not compile with default -Werror option."   ON)
+else()
+    # strict config defaults for Git developer builds
+    message(STATUS "===== UPX info: strict config defaults enabled")
+    option(UPX_CONFIG_DISABLE_GITREV   "Do not compile with default Git version info." OFF)
+    option(UPX_CONFIG_DISABLE_SANITIZE "Do not compile with default sanitize options." OFF)
+    option(UPX_CONFIG_DISABLE_WSTRICT  "Do not compile with strict compiler warnings." OFF)
+    option(UPX_CONFIG_DISABLE_WERROR   "Do not compile with default -Werror option."   OFF)
+endif()
+
+# test config options (see below)
+# IMPORTANT NOTE: self-pack test can only work if the host executable format is supported by UPX!
+option(UPX_CONFIG_DISABLE_SELF_PACK_TEST "Do not test packing UPX with itself" OFF)
+
+#***********************************************************************
+# init
+#***********************************************************************
+
+# Disallow in-source builds. Note that you will still have to manually
+# clean up a few files if you accidentally try an in-source build.
+if(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.git")
+    set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+    set(CMAKE_DISABLE_SOURCE_CHANGES  ON)
+    if(",${CMAKE_CURRENT_SOURCE_DIR}," STREQUAL ",${CMAKE_CURRENT_BINARY_DIR},")
+        message(FATAL_ERROR "ERROR: In-source builds are not allowed, please use an extra build dir.")
+    endif()
+endif()
+
+# useful for CI jobs: allow settings via environment and cache result
+function(upx_cache_bool_vars)
+    set(default_value "${ARGV0}")
+    list(REMOVE_AT ARGV 0)
+    foreach(var ${ARGV})
+        set(value ${default_value})
+        if(DEFINED UPX_CACHE_${var})
+            set(value "${UPX_CACHE_${var}}")
+        elseif(DEFINED ${var})
+            set(value "${${var}}")
+        elseif("$ENV{${var}}" MATCHES "^(0|1|OFF|ON|FALSE|TRUE)$")
+            set(value "$ENV{${var}}")
+            set(UPX_CACHE_ORIGIN_FROM_ENV_${var} TRUE CACHE INTERNAL "" FORCE)
+        endif()
+        if(value)
+            set(value ON)
+        else()
+            set(value OFF)
+        endif()
+        if(UPX_CACHE_ORIGIN_FROM_ENV_${var})
+            message(STATUS "setting from environment: ${var} = ${value}")
+        endif()
+        set(${var} "${value}" PARENT_SCOPE)
+        set(UPX_CACHE_${var} "${value}" CACHE INTERNAL "" FORCE)
+    endforeach()
+endfunction()
+
+# global settings
+if(${CMAKE_VERSION} VERSION_GREATER "3.14.7" AND NOT DEFINED CMAKE_MSVC_RUNTIME_LIBRARY)
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded")
+    cmake_policy(SET CMP0091 NEW)
+endif()
+# global CMake settings that default to ON
+upx_cache_bool_vars(ON
+    CMAKE_C_STANDARD_REQUIRED CMAKE_CXX_STANDARD_REQUIRED
+    CMAKE_EXPORT_COMPILE_COMMANDS CMAKE_REQUIRED_QUIET
+)
+# internal UPX settings that default to OFF
+upx_cache_bool_vars(OFF
+    UPX_CONFIG_CMAKE_DISABLE_TEST UPX_CONFIG_CMAKE_DISABLE_INSTALL
+    UPX_CONFIG_CMAKE_DISABLE_PRINT_INFO UPX_CONFIG_CMAKE_DISABLE_PLATFORM_CHECK
+    UPX_CONFIG_DISABLE_C_STANDARD UPX_CONFIG_DISABLE_CXX_STANDARD
+)
+
+# determine Git revision
+set(GITREV_SHORT "")
+set(GITREV_PLUS "")
+set(GIT_DESCRIBE "")
+if(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/.git" AND NOT UPX_CONFIG_DISABLE_GITREV)
+    find_package(Git)
+    if(Git_FOUND)
+        execute_process(
+            COMMAND "${GIT_EXECUTABLE}" rev-parse --short=12 HEAD
+            RESULT_VARIABLE result ERROR_QUIET
+            OUTPUT_VARIABLE GITREV_SHORT OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        string(LENGTH "${GITREV_SHORT}" l)
+        if(${result} EQUAL 0 AND ${l} EQUAL 12)
+            execute_process(RESULT_VARIABLE result COMMAND "${GIT_EXECUTABLE}" diff --quiet)
+            if(NOT ${result} EQUAL 0)
+                set(GITREV_PLUS "+")
+            endif()
+        else()
+            set(GITREV_SHORT "")
+        endif()
+        execute_process(
+            COMMAND "${GIT_EXECUTABLE}" describe --match "v*.*.*" --tags --dirty
+            RESULT_VARIABLE result ERROR_QUIET
+            OUTPUT_VARIABLE GIT_DESCRIBE OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+        if(GIT_DESCRIBE MATCHES "^v?([0-9]+\\.[0-9]+\\.[0-9]+)-([0-9]+)-g(.+)$")
+            set(GIT_DESCRIBE "${CMAKE_MATCH_1}-devel.${CMAKE_MATCH_2}+git-${CMAKE_MATCH_3}")
+        endif()
+    endif()
+endif()
+if(GITREV_SHORT)
+    message(STATUS "UPX_VERSION_GITREV = \"${GITREV_SHORT}${GITREV_PLUS}\"")
+    if(GIT_DESCRIBE)
+        message(STATUS "UPX_VERSION_GIT_DESCRIBE = \"${GIT_DESCRIBE}\"")
+    endif()
+elseif(UPX_CONFIG_DISABLE_GITREV)
+    message(STATUS "UPX_VERSION_GITREV: disabled")
+else()
+    message(STATUS "UPX_VERSION_GITREV: not set")
+endif()
+
+# set the default build type to "Release"
+get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+if(NOT is_multi_config AND NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
+endif()
+
+# CMake init
+project(upx VERSION 4.1.0 LANGUAGES C CXX)
+
+# set the default multi-config build type to "Release"
+if(is_multi_config)
+    set(c "${CMAKE_CONFIGURATION_TYPES}")
+    list(INSERT c 0 "Release")
+    list(INSERT c 1 "Debug")
+    if(CMAKE_BUILD_TYPE)
+        list(INSERT c 0 "${CMAKE_BUILD_TYPE}")
+    endif()
+    list(REMOVE_DUPLICATES c)
+    set(CMAKE_CONFIGURATION_TYPES "${c}" CACHE STRING "List of supported configuration types." FORCE)
+endif()
+
+# set MSVC_FRONTEND
+set(MSVC_FRONTEND 0)
+if(MSVC OR CMAKE_C_COMPILER_FRONTEND_VARIANT MATCHES "^MSVC")
+    set(MSVC_FRONTEND 1)
+endif()
+
+#***********************************************************************
+# common compilation flags
+#***********************************************************************
+
+include(CheckCCompilerFlag)
+
+if(UPX_CONFIG_DISABLE_WSTRICT)
+    # enable all basic warnings
+    set(warn_Wall -Wall)
+    set(warn_WN -W3)
+else()
+    # enable all basic warnings, and enable lots of strict warnings
+    set(warn_Wall -Wall -Wextra -Wcast-align -Wcast-qual -Wmissing-declarations -Wpointer-arith -Wshadow -Wvla -Wwrite-strings)
+    set(warn_WN -W4)
+endif()
+if(UPX_CONFIG_DISABLE_WERROR)
+    # warnings are just warnings
+    set(warn_Werror "")
+    set(warn_WX "")
+else()
+    # warnings are fatal errors; annoy developers to keep the source code warning-free
+    set(warn_Werror -Werror)
+    set(warn_WX -WX)
+endif()
+
+function(upx_add_definitions_with_prefix)
+    set(flag_prefix "${ARGV0}")
+    if(flag_prefix MATCHES "^dummy$") # need dummy to work around bug in old CMake versions
+        set(flag_prefix "")
+    endif()
+    list(REMOVE_AT ARGV 0)
+    set(failed "")
+    foreach(f ${ARGV})
+        set(flag "${flag_prefix}${f}")
+        string(REGEX REPLACE "[^0-9a-zA-Z_]" "_" cache_var "HAVE_CFLAG_${flag}")
+        check_c_compiler_flag("${flag}" ${cache_var})
+        if(${cache_var})
+            #message(STATUS "add_definitions: ${flag}")
+            add_definitions("${flag}")
+        else()
+            list(APPEND failed "${f}")
+        endif()
+    endforeach()
+    set(failed_flags "${failed}" PARENT_SCOPE) # return value
+endfunction()
+
+function(upx_add_definitions)
+    set(failed_flags "")
+    if(MSVC_FRONTEND AND CMAKE_C_COMPILER_ID MATCHES "Clang")
+        # for clang-cl try "-clang:" flag prefix first
+        upx_add_definitions_with_prefix("-clang:" ${ARGV})
+        upx_add_definitions_with_prefix("dummy" ${failed_flags})
+    else()
+        upx_add_definitions_with_prefix("dummy" ${ARGV})
+    endif()
+endfunction()
+
+if(NOT CMAKE_C_COMPILER_ID MATCHES "^MSVC")
+    # use -O2 instead of -O3 to reduce code size
+    string(REGEX REPLACE "(^| )-O3( |$$)" "\\1-O2\\2" a "${CMAKE_C_FLAGS_RELEASE}")
+    string(REGEX REPLACE "(^| )-O3( |$$)" "\\1-O2\\2" b "${CMAKE_CXX_FLAGS_RELEASE}")
+    set(CMAKE_C_FLAGS_RELEASE "${a}" CACHE STRING "Flags used by the C compiler during RELEASE builds." FORCE)
+    set(CMAKE_CXX_FLAGS_RELEASE "${b}" CACHE STRING "Flags used by the CXX compiler during RELEASE builds." FORCE)
+endif()
+if(MSVC_FRONTEND)
+    # disable silly warnings about using "deprecated" POSIX functions like fopen()
+    add_definitions(-D_CRT_NONSTDC_NO_DEPRECATE)
+    add_definitions(-D_CRT_NONSTDC_NO_WARNINGS)
+    add_definitions(-D_CRT_SECURE_NO_DEPRECATE)
+    add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+    # use -funsigned-char; set __cplusplus according to selected C++ standard
+    add_definitions(-J -Zc:__cplusplus)
+    if(CMAKE_C_COMPILER_ID MATCHES "^MSVC")
+        upx_add_definitions(-Zc:preprocessor) # use new preprocessor
+    endif()
+endif()
+if(NOT CMAKE_C_COMPILER_ID MATCHES "^MSVC")
+    # protect against security threats caused by misguided compiler "optimizations"
+    upx_add_definitions(-fno-delete-null-pointer-checks -fno-lifetime-dse)
+    upx_add_definitions(-fno-strict-aliasing -fno-strict-overflow -funsigned-char)
+    # disable overambitious auto-vectorization until this actually gains something
+    upx_add_definitions(-fno-tree-vectorize)
+    # disable annoying clang warnings which get added by the macOS Xcode cmake generator
+    if(CMAKE_GENERATOR MATCHES "Xcode")
+        upx_add_definitions(-Wno-shorten-64-to-32)
+    endif()
+endif()
+
+# compile a target with -O2 even in Debug build
+function(upx_compile_target_debug_with_O2)
+    foreach(t ${ARGV})
+        if(MSVC_FRONTEND)
+            # MSVC uses some Debug compilation options like -RTC1 that are incompatible with -O2
+        else()
+            target_compile_options(${t} PRIVATE $<$<CONFIG:Debug>:-O2>)
+        endif()
+    endforeach()
+endfunction()
+
+# sanitize a target
+function(upx_sanitize_target)
+    foreach(t ${ARGV})
+        if(UPX_CONFIG_DISABLE_SANITIZE)
+            # no-op
+        elseif(MSVC_FRONTEND)
+            # MSVC uses -GS (similar to -fstack-protector) by default
+        elseif(CMAKE_C_PLATFORM_ID MATCHES "^MinGW" OR MINGW OR CYGWIN)
+            # avoid link errors with current MinGW-w64 versions
+            # see https://www.mingw-w64.org/contribute/#sanitizers-asan-tsan-usan
+        else()
+            # default sanitizer for Debug builds
+            target_compile_options(${t} PRIVATE $<$<CONFIG:Debug>:-fsanitize=undefined -fsanitize-undefined-trap-on-error -fstack-protector-all>)
+            # default sanitizer for Release builds
+            target_compile_options(${t} PRIVATE $<$<CONFIG:MinSizeRel>:-fstack-protector>)
+            target_compile_options(${t} PRIVATE $<$<CONFIG:Release>:-fstack-protector>)
+            target_compile_options(${t} PRIVATE $<$<CONFIG:RelWithDebInfo>:-fstack-protector>)
+        endif()
+    endforeach()
+endfunction()
+
+#***********************************************************************
+# targets
+#***********************************************************************
+
+# internal settings
+set(UPX_CONFIG_DISABLE_THREADS ON) # multithreading is currently not used; maybe in UPX version 5
+set(UPX_CONFIG_DISABLE_BZIP2 ON)   # bzip2 is currently not used; we might need it to decompress linux kernels
+set(UPX_CONFIG_DISABLE_ZSTD ON)    # zstd is currently not used; maybe in UPX version 5
+
+if(NOT UPX_CONFIG_DISABLE_THREADS)
+    find_package(Threads)
+endif()
+
+if(NOT UPX_CONFIG_DISABLE_BZIP2)
+file(GLOB bzip2_SOURCES "vendor/bzip2/*.c")
+list(SORT bzip2_SOURCES)
+add_library(upx_vendor_bzip2 STATIC ${bzip2_SOURCES})
+if(NOT UPX_CONFIG_DISABLE_C_STANDARD)
+    set_property(TARGET upx_vendor_bzip2 PROPERTY C_STANDARD 11)
+endif()
+endif() # UPX_CONFIG_DISABLE_BZIP2
+
+file(GLOB ucl_SOURCES "vendor/ucl/src/*.c")
+list(SORT ucl_SOURCES)
+add_library(upx_vendor_ucl STATIC ${ucl_SOURCES})
+if(NOT UPX_CONFIG_DISABLE_C_STANDARD)
+    set_property(TARGET upx_vendor_ucl PROPERTY C_STANDARD 11)
+endif()
+
+file(GLOB zlib_SOURCES "vendor/zlib/*.c")
+list(SORT zlib_SOURCES)
+add_library(upx_vendor_zlib STATIC ${zlib_SOURCES})
+if(NOT UPX_CONFIG_DISABLE_C_STANDARD)
+    set_property(TARGET upx_vendor_zlib PROPERTY C_STANDARD 11)
+endif()
+
+if(NOT UPX_CONFIG_DISABLE_ZSTD)
+file(GLOB zstd_SOURCES "vendor/zstd/lib/*/*.c")
+list(SORT zstd_SOURCES)
+add_library(upx_vendor_zstd STATIC ${zstd_SOURCES})
+if(NOT UPX_CONFIG_DISABLE_C_STANDARD)
+    set_property(TARGET upx_vendor_zstd PROPERTY C_STANDARD 11)
+endif()
+endif() # UPX_CONFIG_DISABLE_ZSTD
+
+file(GLOB upx_SOURCES "src/*.cpp" "src/[cfu]*/*.cpp")
+list(SORT upx_SOURCES)
+add_executable(upx ${upx_SOURCES})
+if(NOT UPX_CONFIG_DISABLE_CXX_STANDARD)
+    set_property(TARGET upx PROPERTY CXX_STANDARD 17)
+endif()
+target_link_libraries(upx upx_vendor_ucl upx_vendor_zlib)
+if(NOT UPX_CONFIG_DISABLE_BZIP2)
+    target_link_libraries(upx upx_vendor_bzip2)
+endif()
+if(NOT UPX_CONFIG_DISABLE_ZSTD)
+    target_link_libraries(upx upx_vendor_zstd)
+endif()
+if(Threads_FOUND)
+    target_link_libraries(upx Threads::Threads)
+endif()
+
+#***********************************************************************
+# target compilation flags
+#***********************************************************************
+
+if(NOT UPX_CONFIG_DISABLE_BZIP2)
+set(t upx_vendor_bzip2)
+upx_compile_target_debug_with_O2(${t})
+upx_sanitize_target(${t})
+if(MSVC_FRONTEND)
+    target_compile_options(${t} PRIVATE ${warn_WN} -wd4127 -wd4244 -wd4267 ${warn_WX})
+else()
+    target_compile_options(${t} PRIVATE ${warn_Wall} -Wno-implicit-fallthrough ${warn_Werror})
+endif()
+endif() # UPX_CONFIG_DISABLE_BZIP2
+
+set(t upx_vendor_ucl)
+target_include_directories(${t} PRIVATE vendor/ucl/include vendor/ucl)
+upx_compile_target_debug_with_O2(${t})
+upx_sanitize_target(${t})
+if(MSVC_FRONTEND)
+    target_compile_options(${t} PRIVATE ${warn_WN} ${warn_WX})
+else()
+    target_compile_options(${t} PRIVATE ${warn_Wall} ${warn_Werror})
+endif()
+
+set(t upx_vendor_zlib)
+upx_compile_target_debug_with_O2(${t})
+upx_sanitize_target(${t})
+target_compile_definitions(${t} PRIVATE HAVE_VSNPRINTF=1)
+if(MSVC_FRONTEND)
+    target_compile_options(${t} PRIVATE -W3 ${warn_WX})
+else()
+    target_compile_definitions(${t} PRIVATE HAVE_UNISTD_H=1)
+    target_compile_options(${t} PRIVATE -Wall ${warn_Werror})
+    ##target_compile_options(${t} PRIVATE ${warn_Wall} -Wno-cast-align -Wno-cast-qual ${warn_Werror})
+endif()
+
+if(NOT UPX_CONFIG_DISABLE_ZSTD)
+set(t upx_vendor_zstd)
+upx_compile_target_debug_with_O2(${t})
+upx_sanitize_target(${t})
+target_compile_definitions(${t} PRIVATE DYNAMIC_BMI2=0 ZSTD_DISABLE_ASM=1)
+if(MSVC_FRONTEND)
+    target_compile_options(${t} PRIVATE ${warn_WN} ${warn_WX})
+else()
+    target_compile_options(${t} PRIVATE ${warn_Wall} ${warn_Werror})
+endif()
+endif() # UPX_CONFIG_DISABLE_ZSTD
+
+set(t upx)
+target_include_directories(${t} PRIVATE vendor)
+target_compile_definitions(${t} PRIVATE $<$<CONFIG:Debug>:DEBUG=1>)
+if(GITREV_SHORT)
+    target_compile_definitions(${t} PRIVATE UPX_VERSION_GITREV="${GITREV_SHORT}${GITREV_PLUS}")
+    if(GIT_DESCRIBE)
+        target_compile_definitions(${t} PRIVATE UPX_VERSION_GIT_DESCRIBE="${GIT_DESCRIBE}")
+    endif()
+endif()
+if(Threads_FOUND)
+    target_compile_definitions(${t} PRIVATE WITH_THREADS=1)
+endif()
+if(NOT UPX_CONFIG_DISABLE_WSTRICT)
+    target_compile_definitions(${t} PRIVATE UPX_CONFIG_DISABLE_WSTRICT=0)
+endif()
+if(NOT UPX_CONFIG_DISABLE_WERROR)
+    target_compile_definitions(${t} PRIVATE UPX_CONFIG_DISABLE_WERROR=0)
+endif()
+if(NOT UPX_CONFIG_DISABLE_BZIP2)
+    target_compile_definitions(${t} PRIVATE WITH_BZIP2=0) # FIXME TODO
+endif()
+if(NOT UPX_CONFIG_DISABLE_ZSTD)
+    target_compile_definitions(${t} PRIVATE WITH_ZSTD=1)
+endif()
+#upx_compile_target_debug_with_O2(${t})
+upx_sanitize_target(${t})
+if(MSVC_FRONTEND)
+    target_compile_options(${t} PRIVATE -EHsc ${warn_WN} ${warn_WX})
+else()
+    target_compile_options(${t} PRIVATE ${warn_Wall} ${warn_Werror})
+endif()
+
+#***********************************************************************
+# ctest
+# make test
+# ninja test
+#***********************************************************************
+
+if(NOT UPX_CONFIG_CMAKE_DISABLE_TEST)
+
+include(CTest)
+if(NOT CMAKE_CROSSCOMPILING)
+    add_test(NAME upx-version COMMAND upx --version)
+    add_test(NAME upx-help    COMMAND upx --help)
+endif()
+if(NOT CMAKE_CROSSCOMPILING AND NOT UPX_CONFIG_DISABLE_SELF_PACK_TEST)
+    # IMPORTANT NOTE: these tests can only work if the host executable format is supported by UPX!
+    function(upx_add_test)
+        set(name "${ARGV0}")
+        list(REMOVE_AT ARGV 0)
+        add_test(NAME "${name}" COMMAND ${ARGV})
+        set_tests_properties("${name}" PROPERTIES RUN_SERIAL TRUE) # run these tests sequentially
+    endfunction()
+    set(exe ${CMAKE_EXECUTABLE_SUFFIX})
+    set(upx_self_exe "$<TARGET_FILE:upx>")
+    set(fo "--force-overwrite")
+    upx_add_test(upx-self-pack      upx -3         "${upx_self_exe}" ${fo} -o upx-packed${exe})
+    upx_add_test(upx-self-pack-n2b  upx -3 --nrv2b "${upx_self_exe}" ${fo} -o upx-packed-n2b${exe})
+    upx_add_test(upx-self-pack-n2d  upx -3 --nrv2d "${upx_self_exe}" ${fo} -o upx-packed-n2d${exe})
+    upx_add_test(upx-self-pack-n2e  upx -3 --nrv2e "${upx_self_exe}" ${fo} -o upx-packed-n2e${exe})
+    upx_add_test(upx-self-pack-lzma upx -1 --lzma  "${upx_self_exe}" ${fo} -o upx-packed-lzma${exe})
+    upx_add_test(upx-list           upx -l         upx-packed${exe} upx-packed-n2b${exe} upx-packed-n2d${exe} upx-packed-n2e${exe} upx-packed-lzma${exe})
+    upx_add_test(upx-fileinfo       upx --fileinfo upx-packed${exe} upx-packed-n2b${exe} upx-packed-n2d${exe} upx-packed-n2e${exe} upx-packed-lzma${exe})
+    upx_add_test(upx-test           upx -t         upx-packed${exe} upx-packed-n2b${exe} upx-packed-n2d${exe} upx-packed-n2e${exe} upx-packed-lzma${exe})
+    upx_add_test(upx-unpack         upx -d upx-packed${exe} ${fo} -o upx-unpacked${exe})
+    upx_add_test(upx-run-unpacked   ./upx-unpacked${exe} --version-short)
+    upx_add_test(upx-run-packed     ./upx-packed${exe} --version-short)
+endif()
+
+endif() # UPX_CONFIG_CMAKE_DISABLE_TEST
+
+#***********************************************************************
+# cmake --install .
+# make install
+# ninja install
+#***********************************************************************
+
+if(NOT UPX_CONFIG_CMAKE_DISABLE_INSTALL)
+
+# installation prefix and directories
+if(NOT CMAKE_INSTALL_PREFIX)
+    #message(FATAL_ERROR "ERROR: CMAKE_INSTALL_PREFIX is not defined")
+    message(WARNING "WARNING: CMAKE_INSTALL_PREFIX is not defined")
+endif()
+if(CMAKE_INSTALL_PREFIX)
+    include(GNUInstallDirs)
+endif()
+if(CMAKE_INSTALL_PREFIX AND DEFINED CMAKE_INSTALL_FULL_BINDIR)
+    install(TARGETS upx DESTINATION "${CMAKE_INSTALL_FULL_BINDIR}")
+    install(FILES
+        COPYING LICENSE NEWS README doc/THANKS.txt doc/upx-doc.html doc/upx-doc.txt
+        DESTINATION "${CMAKE_INSTALL_FULL_DOCDIR}"
+    )
+    install(FILES doc/upx.1 DESTINATION "${CMAKE_INSTALL_FULL_MANDIR}/man1")
+endif()
+
+endif() # UPX_CONFIG_CMAKE_DISABLE_INSTALL
+
+#***********************************************************************
+# finally print some info about the build configuration
+#***********************************************************************
+
+function(print_var)
+    foreach(var ${ARGV})
+        if(${var})
+            message(STATUS "${var} = ${${var}}")
+        endif()
+    endforeach()
+endfunction()
+
+if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/maint/make/CMakeLists.maint.txt")
+include("${CMAKE_CURRENT_SOURCE_DIR}/maint/make/CMakeLists.maint.txt")
+endif()
+
+print_var(CMAKE_VERSION UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION CMAKE_GENERATOR)
+if(NOT UPX_CONFIG_CMAKE_DISABLE_PRINT_INFO)
+print_var(CMAKE_HOST_SYSTEM_NAME CMAKE_HOST_SYSTEM_VERSION)
+print_var(CMAKE_SYSTEM_NAME CMAKE_SYSTEM_VERSION CMAKE_CROSSCOMPILING)
+print_var(CMAKE_C_COMPILER_ID CMAKE_C_COMPILER_VERSION CMAKE_C_COMPILER_FRONTEND_VARIANT CMAKE_C_COMPILER_ARCHITECTURE_ID CMAKE_C_PLATFORM_ID CMAKE_C_COMPILER_ABI)
+print_var(CMAKE_CXX_COMPILER_ID CMAKE_CXX_COMPILER_VERSION CMAKE_CXX_COMPILER_FRONTEND_VARIANT CMAKE_CXX_COMPILER_ARCHITECTURE_ID CMAKE_CXX_PLATFORM_ID CMAKE_CXX_COMPILER_ABI)
+print_var(CMAKE_POSITION_INDEPENDENT_CODE)
+print_var(CYGWIN GNUC MINGW MSVC MSVC_FRONTEND MSVC_IDE WIN32 WIN64)
+endif() # UPX_CONFIG_CMAKE_DISABLE_PRINT_INFO
+print_var(CMAKE_INSTALL_PREFIX CMAKE_CONFIGURATION_TYPES CMAKE_BUILD_TYPE)
+if(CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE MATCHES "^(Debug|None|Release)$")
+    message(WARNING "WARNING: unsupported CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}; please use \"Debug\" or \"Release\"")
+endif()
+
+# extra sanity checks to detect incompatible C vs CXX settings
+if(NOT UPX_CONFIG_CMAKE_DISABLE_PLATFORM_CHECK)
+if(NOT ",${CMAKE_C_PLATFORM_ID}," STREQUAL ",${CMAKE_CXX_PLATFORM_ID},")
+    message(FATAL_ERROR "ERROR: CMAKE_C_PLATFORM_ID CMAKE_CXX_PLATFORM_ID mismatch")
+endif()
+if(NOT ",${CMAKE_C_COMPILER_ABI}," STREQUAL ",${CMAKE_CXX_COMPILER_ABI},")
+    message(FATAL_ERROR "ERROR: CMAKE_C_COMPILER_ABI CMAKE_CXX_COMPILER_ABI mismatch")
+endif()
+if(NOT ",${CMAKE_C_COMPILER_FRONTEND_VARIANT}," STREQUAL ",${CMAKE_CXX_COMPILER_FRONTEND_VARIANT},")
+    message(FATAL_ERROR "ERROR: CMAKE_C_COMPILER_FRONTEND_VARIANT CMAKE_CXX_COMPILER_FRONTEND_VARIANT mismatch")
+endif()
+endif() # UPX_CONFIG_CMAKE_DISABLE_PLATFORM_CHECK
+
+# vim:set ft=cmake ts=4 sw=4 tw=0 et:

COPYING

@@ -1,8 +1,8 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -15,7 +15,7 @@ software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.)  You can apply it to
+the GNU Lesser General Public License instead.)  You can apply it to
 your programs, too.
 
   When we speak of free software, we are referring to freedom, not
@@ -55,7 +55,7 @@ patent must be licensed for everyone's free use or not licensed at all.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
-
+
                     GNU GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
     License.  (Exception: if the Program itself is interactive but
     does not normally print such an announcement, your work based on
     the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
   4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -225,7 +225,7 @@ impose that choice.
 
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
   8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
                      END OF TERMS AND CONDITIONS
-
+
             How to Apply These Terms to Your New Programs
 
   If you develop a new program, and you want it to be of the greatest
@@ -291,7 +291,7 @@ convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) 19yy  <name of author>
+    Copyright (C) <year>  <name of author>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -303,17 +303,16 @@ the "copyright" line and a pointer to where the full notice is found.
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 Also add information on how to contact you by electronic and paper mail.
 
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
 
-    Gnomovision version 69, Copyright (C) 19yy name of author
+    Gnomovision version 69, Copyright (C) year name of author
     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.
@@ -336,5 +335,5 @@ necessary.  Here is a sample; alter the names:
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Library General
+library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.

Makefile

@@ -1,27 +1,231 @@
-# Toplevel Makefile for UPX
+#
+# UPX top-level Makefile - needs GNU make and CMake >= 3.13
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+#
 
-all:
-	$(MAKE) -C src/stub
-	$(MAKE) -C src
-	$(MAKE) -C doc
+# INFO: this Makefile is just a convenience wrapper for calling CMake
 
-mostlyclean clean distclean maintainer-clean:
-	$(MAKE) -C src/stub $@
-	$(MAKE) -C src $@
-	$(MAKE) -C doc $@
+# HINT: if you only have an older CMake 3.x then you can invoke cmake manually like this:
+#   mkdir -p build/release
+#   cd build/release
+#   cmake ../..
+#   make -j     (or use "cmake --build . --parallel")
 
-dist: distclean
-	false
+CMAKE = cmake
+UPX_CMAKE_BUILD_FLAGS += --parallel
+ifneq ($(VERBOSE),)
+  #UPX_CMAKE_BUILD_FLAGS += --verbose # requires CMake >= 3.14
+  UPX_CMAKE_CONFIG_FLAGS += -DCMAKE_VERBOSE_MAKEFILE=ON
+endif
+# enable this if you prefer Ninja for the actual builds:
+#UPX_CMAKE_CONFIG_FLAGS += -G Ninja
 
-cvs-admin-ko:
-	cvs admin -ko .
-	cvs update
+#***********************************************************************
+# default
+#***********************************************************************
 
-ChangeLog:
-	perl scripts/cvs2cl.pl --utc -f ChangeLog.cvs
+run_cmake_config = $(CMAKE) -S . -B $1 $(UPX_CMAKE_CONFIG_FLAGS) -DCMAKE_BUILD_TYPE=$2
+run_cmake_build  = $(CMAKE) --build $1 $(UPX_CMAKE_BUILD_FLAGS) --config $2
+# avoid re-running run_cmake_config if CMakeCache.txt already exists
+run_config       = $(if $(wildcard $1/CMakeCache.txt),,$(call run_cmake_config,$1,$2))
+run_build        = $(call run_cmake_build,$1,$2)
 
-.PHONY: all mostlyclean clean distclean maintainer-clean
-.PHONY: dist cvs-admin-ko ChangeLog
+.DEFAULT_GOAL = build/release
 
-.NOEXPORT:
+build/debug: PHONY
+	$(call run_config,$@,Debug)
+	$(call run_build,$@,Debug)
 
+build/release: PHONY
+	$(call run_config,$@,Release)
+	$(call run_build,$@,Release)
+
+# shortcuts
+all: build/debug build/release
+debug: build/debug
+release: build/release
+
+.NOTPARALLEL: # because the actual builds use "cmake --parallel"
+.PHONY: PHONY
+.SECONDEXPANSION:
+.SUFFIXES:
+
+#
+# END of Makefile; extra stuff follows
+#
+
+#***********************************************************************
+# extra builds: some pre-defined build configurations
+#***********************************************************************
+
+define run_config_and_build
+	$(call run_config,$1,$2)
+	$(call run_build,$1,$2)
+endef
+
+# force building with clang/clang++
+build/extra/clang/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/clang/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/clang/%: export CC  = clang
+build/extra/clang/%: export CXX = clang++
+
+# force building with clang/clang++ -m32
+build/extra/clang-m32/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/clang-m32/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/clang-m32/%: export CC  = clang -m32
+build/extra/clang-m32/%: export CXX = clang++ -m32
+
+# force building with clang/clang++ -mx32
+build/extra/clang-mx32/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/clang-mx32/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/clang-mx32/%: export CC  = clang -mx32
+build/extra/clang-mx32/%: export CXX = clang++ -mx32
+
+# force building with clang/clang++ -m64
+build/extra/clang-m64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/clang-m64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/clang-m64/%: export CC  = clang -m64
+build/extra/clang-m64/%: export CXX = clang++ -m64
+
+# force building with clang/clang++ -static
+build/extra/clang-static/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/clang-static/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/clang-static/%: export CC  = clang -static
+build/extra/clang-static/%: export CXX = clang++ -static
+
+# force building with gcc/g++
+build/extra/gcc/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/gcc/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/gcc/%: export CC  = gcc
+build/extra/gcc/%: export CXX = g++
+
+# force building with gcc/g++ -m32
+build/extra/gcc-m32/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/gcc-m32/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/gcc-m32/%: export CC  = gcc -m32
+build/extra/gcc-m32/%: export CXX = g++ -m32
+
+# force building with gcc/g++ -mx32
+build/extra/gcc-mx32/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/gcc-mx32/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/gcc-mx32/%: export CC  = gcc -mx32
+build/extra/gcc-mx32/%: export CXX = g++ -mx32
+
+# force building with gcc/g++ -m64
+build/extra/gcc-m64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/gcc-m64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/gcc-m64/%: export CC  = gcc -m64
+build/extra/gcc-m64/%: export CXX = g++ -m64
+
+# force building with gcc/g++ -static
+build/extra/gcc-static/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/gcc-static/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/gcc-static/%: export CC  = gcc -static
+build/extra/gcc-static/%: export CXX = g++ -static
+
+# cross compiler: Linux glibc aarch64-linux-gnu (arm64)
+build/extra/cross-linux-gnu-aarch64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-linux-gnu-aarch64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-linux-gnu-aarch64/%: export CC  = aarch64-linux-gnu-gcc
+build/extra/cross-linux-gnu-aarch64/%: export CXX = aarch64-linux-gnu-g++
+
+# cross compiler: Linux glibc arm-linux-gnueabihf
+build/extra/cross-linux-gnu-arm-eabihf/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-linux-gnu-arm-eabihf/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-linux-gnu-arm-eabihf/%: export CC  = arm-linux-gnueabihf-gcc
+build/extra/cross-linux-gnu-arm-eabihf/%: export CXX = arm-linux-gnueabihf-g++ -Wno-psabi
+
+# cross compiler: Windows x86 win32 MinGW (i386)
+build/extra/cross-windows-mingw32/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-windows-mingw32/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-windows-mingw32/%: export CC  = i686-w64-mingw32-gcc -static
+build/extra/cross-windows-mingw32/%: export CXX = i686-w64-mingw32-g++ -static
+
+# cross compiler: Windows x64 win64 MinGW (amd64)
+build/extra/cross-windows-mingw64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-windows-mingw64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-windows-mingw64/%: export CC  = x86_64-w64-mingw32-gcc -static
+build/extra/cross-windows-mingw64/%: export CXX = x86_64-w64-mingw32-g++ -static
+
+# cross compiler: macOS arm64 (aarch64)
+build/extra/cross-darwin-arm64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-darwin-arm64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-darwin-arm64/%: export CC  = clang -target arm64-apple-darwin
+build/extra/cross-darwin-arm64/%: export CXX = clang++ -target arm64-apple-darwin
+
+# cross compiler: macOS x86_64 (amd64)
+build/extra/cross-darwin-x86_64/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/extra/cross-darwin-x86_64/release: PHONY; $(call run_config_and_build,$@,Release)
+build/extra/cross-darwin-x86_64/%: export CC  = clang -target x86_64-apple-darwin
+build/extra/cross-darwin-x86_64/%: export CXX = clang++ -target x86_64-apple-darwin
+
+#***********************************************************************
+# C/C++ static analyzers
+#***********************************************************************
+
+# force building with clang Static Analyzer (scan-build)
+build/analyze/clang-analyzer/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/analyze/clang-analyzer/release: PHONY; $(call run_config_and_build,$@,Release)
+build/analyze/clang-analyzer/%: CMAKE := scan-build $(CMAKE)
+build/analyze/clang-analyzer/%: export CCC_CC  ?= clang
+build/analyze/clang-analyzer/%: export CCC_CXX ?= clang++
+
+# run clang-tidy: uses file compile_commands.json from an existing clang build
+# does not create any actual files, so purely PHONY
+RUN_CLANG_TIDY = time python3 ./misc/analyze/clang-tidy/run-clang-tidy.py -p $<
+RUN_CLANG_TIDY_WERROR = $(RUN_CLANG_TIDY) '-warnings-as-errors=*'
+build/analyze/clang-tidy-upx/debug build/analyze/clang-tidy-upx/release: build/extra/clang/$$(notdir $$@) PHONY
+	$(RUN_CLANG_TIDY_WERROR) -config-file ./.clang-tidy '/src/.*\.cpp'
+build/analyze/clang-tidy-bzip2/debug build/analyze/clang-tidy-bzip2/release: build/extra/clang/$$(notdir $$@) PHONY
+	$(RUN_CLANG_TIDY)        -config-file ./misc/analyze/clang-tidy/clang-tidy-bzip2.yml /vendor/bzip2/
+build/analyze/clang-tidy-ucl/debug build/analyze/clang-tidy-ucl/release: build/extra/clang/$$(notdir $$@) PHONY
+	$(RUN_CLANG_TIDY_WERROR) -config-file ./misc/analyze/clang-tidy/clang-tidy-ucl.yml   /vendor/ucl/
+build/analyze/clang-tidy-zlib/debug build/analyze/clang-tidy-zlib/release: build/extra/clang/$$(notdir $$@) PHONY
+	$(RUN_CLANG_TIDY_WERROR) -config-file ./misc/analyze/clang-tidy/clang-tidy-zlib.yml  /vendor/zlib/
+build/analyze/clang-tidy-zstd/debug build/analyze/clang-tidy-zstd/release: build/extra/clang/$$(notdir $$@) PHONY
+	$(RUN_CLANG_TIDY)        -config-file ./misc/analyze/clang-tidy/clang-tidy-zstd.yml  /vendor/zstd/
+build/analyze/clang-tidy/debug build/analyze/clang-tidy/release: build/analyze/clang-tidy-upx/$$(notdir $$@)
+build/analyze/clang-tidy/debug build/analyze/clang-tidy/release: build/analyze/clang-tidy-bzip2/$$(notdir $$@)
+build/analyze/clang-tidy/debug build/analyze/clang-tidy/release: build/analyze/clang-tidy-ucl/$$(notdir $$@)
+build/analyze/clang-tidy/debug build/analyze/clang-tidy/release: build/analyze/clang-tidy-zlib/$$(notdir $$@)
+build/analyze/clang-tidy/debug build/analyze/clang-tidy/release: build/analyze/clang-tidy-zstd/$$(notdir $$@)
+
+# OLD names
+build/extra/scan-build/debug:   build/analyze/clang-analyzer/debug
+build/extra/scan-build/release: build/analyze/clang-analyzer/release
+
+#***********************************************************************
+# advanced: generic extra target
+#***********************************************************************
+
+# usage:
+#   make UPX_XTARGET=my-target CC="my-cc -flags" CXX="my-cxx -flags"
+#   make UPX_XTARGET=my-target CC="my-cc -flags" CXX="my-cxx -flags" xtarget/debug
+
+ifneq ($(UPX_XTARGET),)
+ifneq ($(CC),)
+ifneq ($(CXX),)
+
+UPX_XTARGET := $(UPX_XTARGET)
+build/xtarget/$(UPX_XTARGET)/debug:   PHONY; $(call run_config_and_build,$@,Debug)
+build/xtarget/$(UPX_XTARGET)/release: PHONY; $(call run_config_and_build,$@,Release)
+build/xtarget/$(UPX_XTARGET)/%: export CC
+build/xtarget/$(UPX_XTARGET)/%: export CXX
+# shortcuts
+xtarget/debug:   build/xtarget/$(UPX_XTARGET)/debug
+xtarget/release: build/xtarget/$(UPX_XTARGET)/release
+# set new default
+.DEFAULT_GOAL = xtarget/release
+
+endif
+endif
+endif
+
+#***********************************************************************
+# check git submodules
+#***********************************************************************
+
+SUBMODULES = doctest lzma-sdk ucl valgrind zlib
+
+dummy := $(foreach m,$(SUBMODULES),$(if $(wildcard vendor/$m/[CL]*),$m,\
+    $(error ERROR: missing git submodule '$m'; run 'git submodule update --init')))

NEWS

@@ -2,16 +2,332 @@
 User visible changes for UPX
 ==================================================================
 
+Changes in 4.1.0 (08 Aug 2023):
+  * ELF: handle shared libraries with more than 2 PT_LOAD segments
+  * bug fixes - see https://github.com/upx/upx/milestone/11
+
+Changes in 4.0.2 (30 Jan 2023):
+  * bug fixes - see https://github.com/upx/upx/milestone/9
+
+Changes in 4.0.1 (16 Nov 2022):
+  * bug fixes - see https://github.com/upx/upx/milestone/8
+
+Changes in 4.0.0 (28 Oct 2022):
+  * Switch to semantic versioning
+  * SECURITY NOTES: emphasize the security context in the docs
+  * Support easy building from source code with CMake
+  * Support easy rebuilding the stubs from source with Podman/Docker
+  * Add integrated doctest C++ testing framework
+  * Add support for EFI files (PE x86; Kornel Pal)
+  * win32/pe and win64/pe: set correct SizeOfHeaders in the PE header
+  * bug fixes - see https://github.com/upx/upx/milestone/6
+  * bug fixes - see https://github.com/upx/upx/milestone/7
+
+Changes in 3.96 (23 Jan 2020):
+  * bug fixes - see https://github.com/upx/upx/milestone/5
+
+Changes in 3.95 (26 Aug 2018):
+  * Flag --android-shlib to work around bad design in Android
+  * Flag --force-pie when ET_DYN main program is not marked as DF_1_PIE
+  * Better compatibility with varying layout of address space on Linux
+  * Support for 4 PT_LOAD layout in ELF generated by binutils-2.31
+  * bug fixes, particularly better diagnosis of malformed input
+  * bug fixes - see https://github.com/upx/upx/milestone/4
+
+Changes in 3.94 (12 May 2017):
+  * Add support for arm64-linux (aka "aarch64").
+  * Add support for --lzma compression on 64-bit PowerPC (Thierry Fauck).
+  * For Mach, "upx -d" will unpack a prefix of the file (and warn).
+  * Various improvements to the ELF formats.
+  * bug fixes - see https://github.com/upx/upx/milestone/3
+
+Changes in 3.93 (29 Jan 2017):
+  * Fixed some win32/pe and win64/pe regressions introduced in 3.92
+  * bug fixes - see https://github.com/upx/upx/milestone/2
+
+Changes in 3.92 (11 Dec 2016):
+  * INFO: UPX has moved to GitHub - the new home page is https://upx.github.io
+  * IMPORTANT: all PE formats: internal changes: reunited the diverged source
+    files - please report all regressions into the bug tracker and try UPX 3.91
+    in case of problems.
+  * Support Apple MacOS 10.12 "Sierra", including more-robust de-compression.
+  * Explicitly diagnose Go-language bad PT_LOAD; recommend hemfix.c.
+    https://sourceforge.net/p/upx/bugs/195/   https://github.com/pwaller/goupx
+  * Fix CERT-FI Case 829767 UPX command line tools segfaults.
+    Received by UPX Team on 2015-May-08; originally reported
+    by Codenomicon to NCSC-FI on 2015-01-08.
+    The vulnerabilities were discovered by Joonas Kuorilehto and
+    Antti Häyrynen from Codenomicon.
+  * bug fixes - see https://github.com/upx/upx/milestone/1
+
+Changes in 3.91 (30 Sep 2013):
+  * Added experimental support for Windows 64-bit PE files, based on
+    work by Stefan Widmann. Please use for testing only!
+  * bug fixes
+
+==================================================================
+
+Changes in 3.09 (18 Feb 2013):
+  * New option --preserve-build-id for GNU ELF.
+  * Allow for code signing and LC_UUID on Mac OS X executables.
+  * Allow non-contiguous LC_SEGMENTs and 0==.vmsize for Mach-O.
+  * Allow zero-filled final page in PackUnix::canUnpack().
+  * bug fixes
+
+Changes in 3.08 (12 Dec 2011):
+  * Fix allocation in runtime stub for darwin.macho-entry (i386 and amd64).
+  * Compress shared library on ELF i386 only [ld.so threatens even this case].
+  * Attempt to support ELF on QNX 6.3.0 for armel (experimental).
+  * Better diagnostic when ELF -fPIC is needed.
+  * PT_NOTE improvements for BSD.
+  * Preserve more ELF .e_flags on ARM.
+  * Minor code improvements for ELF stubs.
+  * Defend against another flavor of corrupt PE header.
+  * bug fixes
+
+Changes in 3.07 (08 Sep 2010):
+  * win32/pe: fixed relocation handling for files with *no* TLS callbacks
+    [severe bug introduced in 3.06]
+
+Changes in 3.06 (04 Sep 2010):
+  * win32/pe: TLS callback support contributed by Stefan Widmann. Thanks!
+  * bug fixes
+
+Changes in 3.05 (27 Apr 2010):
+  * i386-linux and amd64-linux support shared libraries (DT_INIT must
+    exist, all info needed by runtime loader must be first in .text, etc.)
+  * Linux /proc/self/exe now is preserved by default, by leaving behind
+    one page.  New compress-time option --unmap-all-pages is available.
+  * Withdraw support for shared libraries on Darwin (Apple Mac OS X)
+    because upx does not understand enough about .dylib.
+  * bug fixes
+
+Changes in 3.04 (27 Sep 2009):
+  * new format Mach/AMD64 supports 64-bit programs on Apple Macintosh.
+  * new formats Dylib/i386 and Dylib/ppc32 support shared libraries
+    [such as browser plugins] on Darwin (Apple Macintosh).  An existing
+    -init function (LC_ROUTINES command) is required.
+  * new format vmlinuz/armel for Debian NSLU2 (etc.) linux kernel
+  * bvmlinuz boot protocol 2.08 for 386 Linux kernel
+  * Extended ABI version 4 for armel-eabi ARM Linux ELF
+  * bug fixes
+
+Changes in 3.03 (27 Apr 2008):
+  * implement cache flushing for PowerPC (esp. model 440)
+  * fix cache flushing on MIPS (>3 MiB compressed, or with holes)
+  * fix MIPS big-endian
+  * bug fixes
+
+Changes in 3.02 (16 Dec 2007):
+  * fix unmapping on arm-linux.elf
+  * fix error checking in mmap for i386-linux.elf [triggered by -fPIE]
+  * bug fixes
+
+Changes in 3.01 (31 Jul 2007):
+  * new options --no-mode, --no-owner and --no-time to disable preservation
+    of mode (file permissions), file ownership and timestamps.
+  * dos/exe: fixed an incorrect error message caused by a bug in
+    relocation handling
+  * new format linux/mipsel supports ELF on [32-bit] R3000
+  * fix argv[0] on PowerPC with --lzma
+  * bug fixes
+
+Changes in 3.00 (27 Apr 2007):
+  * watcom/le & tmt/adam: fixed a problem when using certain filters
+
+Changes in 2.93 beta (08 Mar 2007):
+  * new formats Mach/i386 and Mach/fat support Mac OS X i686 and
+    Universal binaries [i686 and PowerPC only]
+  * dos/exe: LZMA is now also supported for 16-bit dos/exe. Please note that
+    you have to explicitly use '--lzma' even for '--ultra-brute' here
+    because runtime decompression is about 30 times slower than NRV -
+    which is really noticeable on old machines.
+  * dos/exe: fixed a rarely occurring bug in relocation handling
+  * win32/pe & arm/pe: better icon compression handling
+
+Changes in 2.92 beta (23 Jan 2007):
+  * new option '--ultra-brute' which tries even more variants
+  * slightly improved compression ratio for some files when
+    using '--brute' or '--ultra-brute'
+  * bug fixes
+
+Changes in 2.91 beta (29 Nov 2006):
+  * assorted bug fixes
+  * wince/arm: fix "missing" icon & version info resource problem for WinCE 5
+  * win32/pe & arm/pe: added option --compress-icons=3 to compress all icons
+
+Changes in 2.90 beta (08 Oct 2006):
+  * LZMA algorithm support for most of the 32-bit and 64-bit file formats;
+    use new option '--lzma' to enable
+  * new format: BSD/elf386 supporting FreeBSD, NetBSD and OpenBSD
+    via auto-detection of PT_NOTE or EI_OSABI
+  * arm/pe: all the NRV compression methods are now supported
+    (only NRV2D is missing in thumb mode)
+  * linux/elf386, linux/ElfAMD: remember /proc/self/exe in environment
+  * major source code changes: the runtime decompression stubs are now
+    built from internal ELF objects
+
+==================================================================
+
+Changes in 2.03 (07 Nov 2006):
+  * bvmlinuz/386: fix for kernels not at 0x100000; also allow x86_64
+  * linux/elf386: work around Linux kernel bug (0-length .bss needs PF_W)
+
+Changes in 2.02 (13 Aug 2006):
+  * linux/386: work around Linux kernel bug (".bss" requires PF_W)
+  * linux/ppc32, mach/ppc32: compressed programs now work on a 405 CPU
+  * vmlinuz/386: fixed zlib uncompression problem on DOS
+
+Changes in 2.01 (06 Jun 2006):
+  * arm/pe: better DLL support
+  * dos/exe: device driver support added
+  * linux/386: Fix --force-execve for PaX, grSecurity, and strict SELinux.
+    /tmp must support execve(); therefore /tmp cannot be mounted 'noexec'.
+  * win32/pe & arm/pe: added new option '--keep-resource=' for
+    excluding selected resources from compression
+
+Changes in 2.00 (27 Apr 2006):
+  * linux/386: the stub now prints an error message if some strict
+    SELinux mode does prevent runtime decompression and execution
+    (for a fully SELinux-compatible but otherwise inferior compression
+    format you can use the '--force-execve' option)
+  * linux/386: worked around a problem where certain Linux kernels
+    clobber the %ebx register during a syscall
+  * win32/pe: disable filters for files with broken PE headers
+
+Changes in 1.96 beta (13 Apr 2006):
+  * arm/pe: added filter support
+  * win32/pe: removed an unnecessary check so that Delphi 2006 and
+    Digital Mars C++ programs finally are supported
+
+Changes in 1.95 beta (09 Apr 2006):
+  * arm/pe: added DLL support
+  * arm/pe: added thumb mode stub support
+  * arm/pe: added unpacking support
+  * win32/pe: really worked around R6002 runtime errors
+
+Changes in 1.94 beta (11 Mar 2006):
+  * new format: added support for wince/arm (ARM executables running on WinCE)
+  * new format: added support for linux elf/amd64
+  * new format: added support for linux elf/ppc32
+  * new format: added support for mach/ppc32 (Apple Mac OS X)
+  * win32/pe: hopefully working "load config" support
+  * win32/pe: R6002 runtime errors worked around
+  * win32/pe: the stub now clears the dirty stack
+
+Changes in 1.93 beta (07 Feb 2005):
+  * vmlinuz/386: fixes to support more kernels
+
+Changes in 1.92 beta (20 Jul 2004):
+  * win32/pe: added option '--strip-loadconf' to strip the SEH load
+    config section [NOTE: this option is obsolete since UPX 1.94]
+  * win32/pe: try to detect .NET (win32/net) files [not yet supported by UPX]
+  * vmlinux/386: new format that directly supports building Linux kernels
+  * source code: now compiles cleanly under Win64
+
+Changes in 1.91 beta (30 Jun 2004):
+  * djgpp2/coff: added support for recent binutils versions
+  * linux/elf386, linux/sh386: lots of improvements
+  * vmlinuz/386: added support for recent kernels
+  * watcom/le: don't crash on files without relocations
+  * win32/pe: stricter checks of some PE values
+  * option '--brute' now implies '--crp-ms=999999'.
+  * source code: much improved portability using ACC, the
+    Automatic Compiler Configuration
+  * source code: compile fixes for strict ISO C++ compilers
+  * source code: compile fixes for Win64
+  * re-synced with upx 1.25 branch
+
+Changes in 1.90 beta (11 Nov 2002):
+  * implemented several new options for finer compression control:
+    '--all-methods', '--all-filters' and '--brute'
+  * ps1/exe: new format - UPX now supports PlayStation One programs
+  * linux/386: added the option '--force-execve'
+  * vmlinuz/386: better kernel detection and sanity checks
+  * re-synced with upx 1.24 branch
+  * documentation updates
+
 Changes in 1.11 beta (20 Dec 2000):
-  * UNSTABLE BETA VERSION - DO NOT USE EXCEPT FOR TESTING!!! REALLY.
   * vmlinuz/386: new format - UPX now supports bootable linux kernels
-  * linux/386: added the new direct-to-memory executable formats - no
+  * linux/elf386: added the new ELF direct-to-memory executable format - no
+    more temp files are needed for decompression!
+  * linux/sh386: added the new shell direct-to-memory executable format - no
     more temp files are needed for decompression!
   * reduced overall memory requirements during packing
   * quite a number of internal source code rearrangements
 
+==================================================================
+
+Changes in 1.25 (29 Jun 2004)
+  * INFO: http://upx.sourceforge.net is the new UPX home page
+  * watcom/le: don't crash on files without relocations
+  * win32/pe: stricter checks of some PE values
+  * source code: much improved portability using ACC, the
+    Automatic Compiler Configuration
+  * source code: compile fixes for strict ISO C++ compilers
+  * source code: compile fixes for Win64
+
+Changes in 1.24 (07 Nov 2002)
+  * djgpp2/coff: stricter check of the COFF header to work around a
+    problem with certain binutils versions
+
+Changes in 1.23 (05 Sep 2002)
+  * atari/tos: fixed an unpacking problem where a buffer was too
+    small (introduced in 1.22)
+  * linux/386: don't give up too early if a single block turns out
+    to be incompressible
+  * documentation: added some quick tips how to achieve the best
+    compression ratio for the final release of your application
+  * fixed a rare situation where the exit code was not set correctly
+
+Changes in 1.22 (27 Jun 2002)
+  * atari/tos: the stub now flushes the CPU cache to avoid
+    problems on 68030+ machines
+  * source code: additional compiler support for Borland C++,
+    Digital Mars C++ and Watcom C++
+
+Changes in 1.21 (01 Jun 2002)
+  * New option '--crp-ms=' for slightly better compression at the cost
+    of higher memory requirements during compression.
+    Try 'upx --best --crp-ms=100000'. See the docs for more info.
+  * source code: portability fixes
+  * source code: compile fixes for g++ 3.0 and g++ 3.1
+
+Changes in 1.20 (23 May 2001)
+  * slightly faster compression
+  * work around a gcc problem in the latest djgpp2 distribution
+  * watcom/le: fixed detection of already compressed files
+  * win32/pe: do not compress RT_MANIFEST resource types
+  * win32/pe: improved the error message for empty resource sections
+  * [NOTE: the jump from 1.08 to 1.20 is to avoid confusion with
+           our unstable development releases 1.1x and 1.9x]
+
+Changes in 1.08 (30 Apr 2001)
+  * new native port to atari/tos
+  * win32/pe: shortened the identstring
+  * source code: portability fixes - UPX now builds cleanly under m68k CPUs
+
+Changes in 1.07 (20 Feb 2001)
+  * win32/pe: corrected the TLS callback check
+  * win32/pe: really fixed that rare bug in relocation handling
+  * win32/pe: experimental support for SizeOfHeaders > 0x1000
+  * win32/pe: check for superfluous data between sections
+  * win32/pe: compressing screensavers (.scr) should finally work
+
+Changes in 1.06 (27 Jan 2001)
+  * win32/pe: the check for TLS callbacks introduced in 1.05
+      was too strict - disabled for now
+  * dos/com: decreased the decompressor stack size a little bit
+
+Changes in 1.05 (24 Jan 2001)
+  * win32/pe: refuse to compress programs with TLS callbacks
+  * win32/pe: stub changes to avoid slowdowns with some virus monitors
+  * win32/pe: reverted the relocation handling changes in 1.04
+  * linux/386: dont try to compress Linux kernel images (have a look
+      at the unstable UPX 1.1x beta versions for that)
+
 Changes in 1.04 (19 Dec 2000)
-  * dos/exe: fixed an internal error when using `--no-reloc'
+  * dos/exe: fixed an internal error when using '--no-reloc'
   * win32/pe: fixed a rare bug in the relocation handling code
   * some tunings for the default compression level
 
@@ -19,7 +335,7 @@ Changes in 1.03 (30 Nov 2000)
   * linked with a new version of the NRV compression library:
       - improved compression ratio a little bit
       - overall significantly faster compression
-      - much faster when using high compression levels like `-9' or `--best'
+      - much faster when using high compression levels like '-9' or '--best'
       - much faster with large files
   * atari/tos: added support for FreeMiNT
   * the 32-bit DOS version now uses the new CWSDSTUB extender
@@ -27,7 +343,7 @@ Changes in 1.03 (30 Nov 2000)
 Changes in 1.02 (13 Sep 2000)
   * watcom/le: fixed a problem with the Causeway extender
   * win32/pe: don't automatically strip relocs if they seem needed
-  * support multiple backup generations when using `-k'
+  * support multiple backup generations when using '-k'
   * updated the console screen driver
 
 Changes in 1.01 (09 Apr 2000)
@@ -55,10 +371,12 @@ Changes in 0.99.1 (29 Feb 2000)
 
 Changes in 0.99 (25 Feb 2000)
   * FULL SOURCE CODE RELEASED UNDER THE TERMS OF THE GNU GPL
-  * win32/pe: changed default to `--strip-relocs=1'
+  * win32/pe: changed default to '--strip-relocs=1'
   * dos/com and dos/sys: fixed a bad decompressor problem
   * linux/386: the counter for the progress indicator was off by one
 
+==================================================================
+
 Changes in 0.94 (06 Dec 1999)
   * win32/pe: the stub now calls ExitProcess in case of import errors
   * under DOS and Windows, the environment variable UPX now accepts
@@ -78,7 +396,7 @@ Changes in 0.91 (13 Nov 1999)
   * dos/exe: correctly restore cs when uncompressing
 
 Changes in 0.90 (10 Nov 1999)
-  * all formats: `--overlay=copy' now is the default overlay mode
+  * all formats: '--overlay=copy' now is the default overlay mode
   * improved compression ratio for most files
   * win32/pe: uncompression is finally supported
   * win32/pe: never compress REGISTRY resources
@@ -88,7 +406,7 @@ Changes in 0.90 (10 Nov 1999)
   * win32/pe: somewhat less memory is required during compression
   * linux/386: fixed compression of scripts which was broken since 0.71
   * linux/386: more FreeBSD compatibility issues
-  * changed option: `-i' now prints some more details during compression
+  * changed option: '-i' now prints some more details during compression
     (not finished yet)
 
 Changes in 0.84 (04 Oct 1999)
@@ -104,7 +422,7 @@ Changes in 0.83 (17 Sep 1999)
 Changes in 0.82 (16 Aug 1999)
   * dos/exe: fixed a decompressor bug which could cause crash on some files
   * linux/386: section headers are now stripped from the stub so that
-    `strip' won't ruin a compressed file any longer
+    'strip' won't ruin a compressed file any longer
   * wc/le: support for stack not in the last object disabled again
   * win32/pe: removed some unneeded data
 
@@ -113,32 +431,32 @@ Changes in 0.81 (04 Aug 1999)
   * dos/com: fixed an internal error that could happen with very small files
 
 Changes in 0.80 (03 Aug 1999)
-  * you can set some default options in the environment var `UPX'
+  * you can set some default options in the environment var 'UPX'
   * dos/com: the decompressor stub now checks for enough free memory
   * dos/exe: decompressor rewritten, some bugs are fixed
-  * dos/exe: new option `--no-reloc': no relocation data is put into
+  * dos/exe: new option '--no-reloc': no relocation data is put into
     the DOS header
   * tmt/adam: added support for more stubs, detect already packed files
-  * tmt/adam: new option `--copy-overlay'
+  * tmt/adam: new option '--copy-overlay'
   * wc/le: reduced memory requirement during uncompression
   * wc/le: support files which do not contain their stack in the last object
   * wc/le: fixed a bug which could cause a crash, improved relocation
     handling
-  * wc/le: new option `--copy-overlay'
-  * win32/pe: `--compress-icons=2' is now the default
+  * wc/le: new option '--copy-overlay'
+  * win32/pe: '--compress-icons=2' is now the default
   * win32/pe: even better TLS support
   * win32/pe: versioninfo works on NT
   * win32/pe: import by ordinal from kernel32.dll works
-  * win32/pe: other import improvements: importing a nonexistant DLL
-    results in a usual Windows message, importing a nonexistant function
+  * win32/pe: other import improvements: importing a nonexistent DLL
+    results in a usual Windows message, importing a nonexistent function
     results in program exit (instead of crash ;-)
-  * win32/pe: new option: `--compress-resources=0'
+  * win32/pe: new option: '--compress-resources=0'
   * win32/pe: reduced memory requirement during uncompression, some
     files might even require LESS memory when they're compressed
   * win32/pe: TYPELIBs should work now
   * win32/pe: improved relocation handling, 16-bit relocations should work
-  * win32/pe: new option `--strip-relocs' (only if you know what you are doing)
-  * win32/pe: new option `--copy-overlay'
+  * win32/pe: new option '--strip-relocs' (only if you know what you are doing)
+  * win32/pe: new option '--copy-overlay'
   * important internal changes: now the stubs are built at runtime
 
 Changes in 0.72 (12 May 1999)
@@ -152,20 +470,20 @@ Changes in 0.72 (12 May 1999)
   * linux/386: minor decompressor stub updates, nicer progress bar
 
 Changes in 0.71 (19 Apr 1999)
-  * dos/exe: added option `--no-overlay'
+  * dos/exe: added option '--no-overlay'
   * linux/386: various improvements in the stub, most notably the
     overhead for an extra cleanup process has been removed
   * win32/pe: added support for export forwarders
   * win32/pe: added support for DLLs without entry point or imports
   * win32/pe: yet another .bss fix
-  * win32/pe: new option `--compress-icons=2': compress all icons
+  * win32/pe: new option '--compress-icons=2': compress all icons
     which are not in the first icon directory
   * win32/pe: rearranged stub to avoid false alerts from some virus scanners
 
 Changes in 0.70 (30 Mar 1999)
   * added support for linux/386 executables
   * improved compression ratio quite a bit
-  * added new compression level `--best' to squeeze out even some more bytes
+  * added new compression level '--best' to squeeze out even some more bytes
   * win32/pe: TLS support is much better now
   * win32/pe: --compress-icons=0 should now work as well
   * the usual minor fixes for win32/pe
@@ -182,13 +500,13 @@ Changes in 0.60 (06 Mar 1999)
   * win32/pe: fixed file corruption when the size of the export data is invalid
   * win32/pe: fixed a problem with empty resource data
   * win32/pe: compressed file alignment set to minimum value
-  * win32/pe: made all compressed sections writeable
+  * win32/pe: made all compressed sections writable
   * fixed some other win32/pe bugs
   * fixed an address optimization problem for some not Watcom LE files
   * fixed a bug which could make UPX hang when an exe header contained
     an illegal value
   * added some compression flags for the win32/pe format
-  * added support for Atari ST executables (atari/tos)
+  * added support for Atari ST/TT executables (atari/tos)
   * improved compression ratio
   * improved compression speed
 
@@ -206,12 +524,12 @@ Changes in 0.40 (05 Oct 1998)
   * fixed a small but fatal bug in dos/sys introduced in 0.30
   * fixed a rare bug in dos/exe
   * worked around a bug in djgpp's strip 2.8
-  * Allegro packfile support should work now
+  * djgpp2/coff: Allegro packfile support should work now
   * added dos/exeh compression method (works on 386+)
 
 Changes in 0.30 (27 Jul 1998)
   * fixed a serious bug in the 32-bit compressors - please don't use
-    djgpp/coff and watcom/le compressed files from previous versions,
+    djgpp2/coff and watcom/le compressed files from previous versions,
     some of them are possibly damaged !
   * the 16-bit uncompressors are a little bit shorter & faster
   * fixed progress indicator for VESA and SVGA text modes
@@ -222,4 +540,5 @@ Changes in 0.20 (05 Jul 1998)
 
 Changes in 0.05 (26 May 1998)
   * first public beta release
-
+  * based on experience gained from our previous packers DJP (djgpp2/coff, 1996),
+    lzop (1996) and mfxpak (atari/tos, 1990)

PROJECTS

@@ -1,88 +0,0 @@
-                 ooooo     ooo ooooooooo.   ooooooo  ooooo
-                 `888'     `8' `888   `Y88.  `8888    d8'
-                  888       8   888   .d88'    Y888..8P
-                  888       8   888ooo88P'      `8888'
-                  888       8   888            .8PY888.
-                  `88.    .8'   888           d8'  `888b
-                    `YbodP'    o888o        o888o  o88888o
-
-
-                    The Ultimate Packer for eXecutables
-          Copyright (c) 1996-2000 Markus Oberhumer & Laszlo Molnar
-               http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
-                            http://upx.tsx.org
-
-
-Here are some possible projects from which you can choose if you'd like to
-contribute to UPX. Be sure to get in touch with us first to avoid
-duplicate efforts.
-
-
-User interface:
----------------
-
- - Write a nifty Win32 GUI (in C++), but try to keep the size of the
-   final executable small. Compression should be in a separate
-   thread that calls do_one_file() [see src/work.cpp].
-
- - Draw a nice UPX icon.
-
-
-More formats:
--------------
-
- - add more file formats / platforms (there were volunteers for FreeBSD,
-   BeOS, Windows CE, Amiga, C64, ...)
-
- - add support for self-extracting HTML pages using a Javascript stub
-   (like the AlgART HTML Packer "AHP")
-
-
-Existing formats:
------------------
-
- - dos/com: add support for very long files - convert to exe if necessary
-
- - dos/sys: add support for sys/exe combos
-
- - dos/exe: implement filter support
-
- - djgpp2/coff: add support for DLX dynamic loading
-     (see SEAL http://www.home.sk/public/seal/ )
-
- - linux/i386:
-     - use the new assembly preprocessor stuff (ie. process the file
-       headers internally)
-     - UPX uncompressor daemon
-     - rewrite the stub in assembly (not sure if this is a good idea...)
-     - etc...
- - linux/i386: add a special elf/i386 format that understands
-     ELF files and has filter support
-
- - watcom/le: add support for per section compression, LX support, VXD
-
- - win32/pe: display a nice dialog box in the stub in case
-     of problems (like importing a DLL or function fails)
- - win32/pe: finer control over resource compression, per section
-     compression
- - win32/pe: compressing screensavers looses the description - probably
-     should not compress a special resource type
-
-
-Compression ratio:
-------------------
-
- - invent more effective filters
-
- - I (Markus) will continue to work on better compression algorithms,
-   so be sure to do better than me if you plan working on this ;-)
-
-
-Other:
-------
-
- - anything else you think that could improve UPX...
-
-
-Thanks for your contribution.
-

README

@@ -8,37 +8,18 @@
 
 
                     The Ultimate Packer for eXecutables
-          Copyright (c) 1996-2000 Markus Oberhumer & Laszlo Molnar
-               http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
-                            http://upx.tsx.org
+   Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
+                           https://upx.github.io
 
 
 
-WARNING - UNSTABLE BETA VERSION
-===============================
-
-All versions 1.1x are unstable beta releases - use them only for testing,
-and never distribute a program that is packed with them !
-There will be hidden bugs. Really.
-
-The current stable release is 1.04, and the next stable release
-will be called version 1.20.
-
-The main news since 1.04 are support for bootable Linux kernels ("vmlinuz/386")
-and direct Linux ELF-to-memory decompression ("linux/elf386"), so there's
-no reason to use the unstable versions unless you want to try the new formats.
-
-
 WELCOME
 =======
 
-Welcome to UPX 1.0x, the first production release after almost two years
-of beta testing.
+Welcome to UPX !
 
-Please don't forget to read the new LICENSE - UPX is now distributed
-under the GNU General Public License (GPL) with special exceptions
-allowing the distribution of all compressed executables, including
-commercial programs.
+UPX is a free, secure, portable, extendable, high-performance
+executable packer for several executable formats.
 
 
 INTRODUCTION
@@ -54,106 +35,86 @@ and run exactly as before, with no runtime or memory penalty for most
 of the supported formats.
 
 UPX supports a number of different executable formats, including
-Win95/98/ME/NT/2000 programs and DLLs, DOS programs, and Linux
-executables and kernels.
+Windows programs and DLLs, macOS apps and Linux executables.
 
 UPX is free software distributed under the term of the GNU General
 Public License. Full source code is available.
 
 UPX may be distributed and used freely, even with commercial applications.
-See the UPX License Agreement for details.
+See the UPX License Agreements for details.
 
-UPX is rated number one in the well known Archive Comparison Test. Visit
-http://web.act.by.net/~act/act-exepack.html
 
-UPX aims to be Commercial Quality Freeware.
+SECURITY CONTEXT
+================
+
+IMPORTANT NOTE: UPX inherits the security context of any files it handles.
+
+This means that packing, unpacking, or even testing or listing a file requires
+the same security considerations as actually executing the file.
+
+Use UPX on trusted files only!
 
 
 SHORT DOCUMENTATION
 ===================
 
-`upx program.exe' will compress a program or DLL. For best compression
-results try `upx --best program.exe'.
+'upx program.exe' will compress a program or DLL. For best compression
+results try 'upx --best program.exe' or 'upx --brute program.exe'.
 
 Please see the file UPX.DOC for the full documentation. The files
 NEWS and BUGS also contain various tidbits of information.
 
 
-DISCLAIMER
-==========
-
-UPX comes with ABSOLUTELY NO WARRANTY; for details see the file LICENSE.
-
-Having said that, we think that UPX is quite stable now. Indeed we
-have compressed lots of files without any problems. Also, the
-current version has undergone several months of beta testing -
-actually it's almost 2 years since our first public beta.
-
-This is the first production quality release, and we plan that future
-releases will be backward compatible with this version.
-
-Please report all problems or suggestions to the authors. Thanks.
-
-
 THE FUTURE
 ==========
 
-  - We'd really love to support handheld systems like the PalmPilot because
-    compression makes a lot of sense here. And - because of the atari/tos
-    format - we already have a working decompressor in 68000 assembly.
-    Unfortunately we know next to nothing about the operating system
-    architecture of such handhelds, so we need some information from
-    an expert. Please contact us if you think you can help.
+  - Stay up-to-date with ongoing OS and executable format changes
 
-  - The Linux approach could probably get ported to a lot of other Unix
-    variants, at least for other i386 architectures it shouldn't be too
-    much work. If someone sends me a fresh hard disk and an official
-    FreeBSD/OpenBSD/NetBSD/Solaris/BeOS... CD I might take a look at it ;-)
+  - RISC-V 64 for Linux
+
+  - ARM64 for Windows (help wanted)
 
   - We will *NOT* add any sort of protection and/or encryption.
     This only gives people a false feeling of security because
-    by definition all protectors/compressors can be broken.
-    And don't trust any advertisment of authors of other executable
-    compressors about this topic - just do a websearch on something
-    like "procdump"...
+    all "protectors" can be broken by definition.
 
-  - Fix all remaining bugs - keep your reports coming ;-)
-
-  - See the file PROJECTS in the source code distribution if you want
-    to contribute.
+  - Fix all remaining bugs - please report any issues
+    https://github.com/upx/upx/issues
 
 
 COPYRIGHT
 =========
 
-Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-Copyright (C) 1996-2000 Laszlo Molnar
+Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+Copyright (C) 1996-2023 Laszlo Molnar
+Copyright (C) 2000-2023 John F. Reiser
 
-This program may be used freely, and you are welcome to
-redistribute it under certain conditions.
+UPX is distributed with full source code under the terms of the
+GNU General Public License v2+; either under the pure GPLv2+ (see
+the file COPYING), or (at your option) under the GPLv+2 with special
+exceptions and restrictions granting the free usage for all binaries
+including commercial programs (see the file LICENSE).
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-UPX License Agreement for more details.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-You should have received a copy of the UPX License Agreement along
-with this program; see the file LICENSE. If not, visit the UPX home page.
+You should have received a copy of the UPX License Agreements along
+with this program; see the files COPYING and LICENSE. If not,
+visit the UPX home page.
 
 
 Share and enjoy,
-Markus & Laszlo
+Markus & Laszlo & John
 
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
 
+   John F. Reiser
+   <jreiser@BitWagon.com>
 
 
 [ The term UPX is a shorthand for the Ultimate Packer for eXecutables
   and holds no connection with potential owners of registered trademarks
   or other rights. ]
-
-[ Feel free to contact us if you have commercial compression requirements
-  or interesting job offers. ]
-

README.1ST

@@ -1,28 +0,0 @@
-                 ooooo     ooo ooooooooo.   ooooooo  ooooo
-                 `888'     `8' `888   `Y88.  `8888    d8'
-                  888       8   888   .d88'    Y888..8P
-                  888       8   888ooo88P'      `8888'
-                  888       8   888            .8PY888.
-                  `88.    .8'   888           d8'  `888b
-                    `YbodP'    o888o        o888o  o88888o
-
-
-                    The Ultimate Packer for eXecutables
-
-
-
-WARNING - UNSTABLE BETA VERSION
-===============================
-
-All versions 1.1x are unstable beta releases - use them only for testing,
-and never distribute a program that is packed with them !
-There will be hidden bugs. Really.
-
-The current stable release is 1.04, and the next stable release
-will be called version 1.20.
-
-The main news since 1.04 are support for bootable Linux kernels ("vmlinuz/386")
-and direct Linux ELF-to-memory decompression ("linux/elf386"), so there's
-no reason to use the unstable versions unless you want to try the new formats.
-
-

README.SRC

@@ -27,21 +27,6 @@ Foreword
   Markus & Laszlo
 
 
-Introduction
-------------
-
-  Welcome to the UPX source code release!
-
-  UPX is not a toy for kids. Apart from basic knowledge about executables
-  and data compression you will need to be firm in C++, assembler,
-  Perl and Makefiles. Probably some other things as well.
-
-  If you can't manage to compile it then the sources are
-  probably not for you. Don't email us for help.
-
-  The authors use Linux for development. You might want to as well.
-
-
 Short overview
 --------------
 
@@ -56,59 +41,68 @@ Short overview
      are #included by the individual executable format handlers.
 
 
-Prerequisites
--------------
-
-  - first of all you need to build the UCL compression library
-    http://wildsau.idv.uni-linz.ac.at/mfx/ucl.html
-
-
 Tools needed to build/modify the UPX sources
 --------------------------------------------
 
-  - A modern C++ compiler like gcc 2.95.2 or Visual C++ 6
-    (egcs 1.1.x may work, half-baked implementations like Borland C++ 5.5 won't)
+  - A C++ compiler that fully implements C++17: clang-5, gcc-8 or msvc-2019-16.11
+    (older or other compilers may work but are unsupported, use at your own risk)
 
-  - GNU make for Win32
-    http://wildsau.idv.uni-linz.ac.at/mfx/download/upx/tools/
+  - GNU make
 
-  - GNU make for DOS
-    ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/
+  - CMake 3.13 or better; see https://cmake.org/
 
 
 To compile the packer sources
 -----------------------------
 
-  set the environment variable UCLDIR to point to your UCL installation, e.g.
-
-     set UCLDIR=c:\src\ucl-0.92                       (DOS / Windows)
-     export UCLDIR=$HOME/local/src/ucl-0.92           (Unix)
-
-  then type
-
-     make target=linux         # on linux
-     make target=djgpp2        # for djgpp2
-     make target=mingw32       # for mingw32
-     make target=no-cygwin     # for mingw32 as included in cygwin
-     make target=msc           # for Visual C++ 6.0
+  - just run "make" in the top-level source directory
 
 
 If you want to modify the stub sources you'll also need
 -------------------------------------------------------
 
-  - Nasm - the Netwide Assembler
-    http://www.cryogen.com/Nasm
+  - Podman/Docker: see misc/podman/rebuild-stubs - this
+    is the preferred way of rebuilding the stubs
 
-  - Perl 5.004 or better
-    ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2gnu/perl*b.zip
+  - otherwise you will need:
+    - a Linux host system with Perl, Python2 and some older compat-libs
+    - upx-stubtools - a number of cross-assemblers and cross-compilers.
+      Precompiled binaries for amd64-linux hosts are available from
+      https://github.com/upx/upx-stubtools/releases
 
-  - A68K - a 68000 macro assembler
-    http://wildsau.idv.uni-linz.ac.at/mfx/download/upx/tools/
 
-  - djasm - an assembler for the djgpp stub
-    http://wildsau.idv.uni-linz.ac.at/mfx/download/upx/tools/
+Developer quick start
+---------------------
+ 1)  $ mkdir my-upx; cd my-upx  # new directory for safety and convenience
+ 2)  $ git clone https://github.com/upx/upx.git
+ 3)  $ git clone https://github.com/upx/upx-testsuite.git
+ 4)  # Optional for re-building stubs:
+ 4a)    $ pushd upx/src/stub  # my-upx/upx/src/stub
+ 4b)    $ wget https://github.com/upx/upx-stubtools/releases/download/v20221212/bin-upx-20221212.tar.xz
+          # Extract to $HOME/bin/bin-upx or $HOME/local/bin/bin-upx.
+          # See directions in: https://github.com/upx/upx-stubtools
+ 4c)    $ make clean; make  # verify that you can re-build stubs
+ 4d)    $ popd  # my-upx
+ 5)  $ cd upx  # my-upx/upx
+ 6)  $ git submodule update --init  # compression algorithms, etc.
+        # DO NOT TOUCH vendor/...
+        # After a git merge/pull/etc, then use "git status"
+        # to check whether the vendor directory is clean;
+        # if not, then update via "git submodule update".
+        # If stuck, then reset via "rm -rf vendor; git submodule update --init".
+ 7)  $ mkdir -p build/debug build/release
+ 8)  $ pushd build/debug  # my-upx/upx/build/debug
+ 9)  $ cmake ../..  # configure cmake
+10)  $ cmake --build . --verbose  # optional "--verbose"
+        # This relies on stub/*.h, which YOU must re-build if necessary.
+        # When in doubt, then use "cd src/stub; make clean; make".
+11)  $ popd  # my-upx/upx
+12)  $ cd src  # my-upx/upx/src
+12a)    On MacOS: install homebrew (https:://brew.sh), then "brew install coreutils"
+        and put <some_prefix>/opt/coreutils/libexec/gnubin into PATH so that
+        "readlink -en" and "sha256sum -b" work.
+13)  $ make run-testsuite 2>&1  |  tee testsuite.log
 
-  - Linux (for the linux/i386 stubs)
 
 
 Misc. notes
@@ -123,13 +117,10 @@ Misc. notes
     stream.
   - Use gcc extensions and other compiler specific stuff only through
     macros.
-  - Keep in mind that it should be possible to build UPX on braindead
-    file systems (FAT). Don't use long file names or other things
-    that break building under plain DOS.
 
-***
 
 Some conventions:
+-----------------
 
   - follow our coding style
   - indent level = 4
@@ -138,15 +129,4 @@ Some conventions:
   - Use throwSomeException() functions instead of throw SomeException():
     this makes the code shorter if used often.
 
-***
-
-Patches/Contributions
-
-  - Please send us bug fixes/contributions only using
-
-      diff -u oldfile newfile
-
-    or
-
-      diff -uNr olddirectory newdirectory
-
+# vim:set ts=4 sw=4 et:

TODO

@@ -1,187 +0,0 @@
-NOTE: this TODO list is completely out of date (~ Dec 1999)
-
-===================================================================
-
-- Rearrange this TODO list, sort by categories, add a priority (1-5)
-
-
-For 0.95:
-
-- FIXME: what do we want in 1.00 ???
-
-- add NRV2D for dos/exe (use by default when >= 400 kB)
-
-- implement switch `-m' for method: 1 NRV2B, 2 NRV2D
-
-- DLL problem under NT ? is this fixed ???
-
-
-PE
-==
-
-2 - easy - mfx + ml) new switch(es) : do not compress resource types x,y,z
-    or resource names a,b,c
-3 - medium - ml) rebuild exports
-3 - difficult) don't compress the BSS section and other holes.
-4 - medium - ml) fix when objectalign < 0x1000
-4 - easy - ml) put the original offset of moved resources somewhere into
-    the res.dir. (if it's safe to do)
-4 - ??? - ml) fix FIXMEs
-5 - medium - ml) try to put the preprocessed imports & relocs back to their
-    original section if possible this could save some virtual memory
-    address space
-
-
-COM
-===
-
-
-EXE
-===
-
-
-
-LE
-==
-
-4 - easy - ml) the decompressors are already aligned, no need for an
-    extra alignment
-
-4 - difficult - ml) handle holes in the file
-
-
-TMT
-===
-
-4 - easy - ml) the decompressors are already aligned, no need for an
-    extra alignment
-
-
-LINUX
-=====
-
-4 - ???)
-    - test with AOUT binaries
-    - test with Java binaries
-    - make a compressed program suid. what happens ?
-
-5 - difficult) rewrite the whole stub in assembly
-
-
-SPARC
-=====
-
-3 - easy - ml) finish support - should generate byte-identical versions
-  for all formats (except those which are using Packer::getRandomId())
-
-
-DJGPP2
-======
-
-1 - ???) do we support overlays at all ???
-
-5 - ???) fix file extension handling when the --coff option is set
-
-
-FOR 0.95
-========
-
-- enable automatic dependency tracking
-
-1 - mfx) determine when to use NRV2D, find best c_flags values for
-  NRV2B & NRV2D (see util/runtest.sh)
-
-5 - boring - mfx) Finally fix all screen and UI problems. How boring...
-  Probably should think about the whole system (printf vs. fprintf vs.
-  con_fprintf...)
-
-5 - policy - ml+mfx) Discuss a default C++ style (GNU indent 2.2.3)
-    with Laszlo and use it. Or maybe Artistic Style?
-
-10) Examine why pod2text breaks lines within something like `B<--coff>'.
-    (pod sucks anyway. unfortunately all alternatives as well.)
-
-
-MISC
-====
-
-3 - difficult ml) The first two sentences of the README look too much like
-  those from the aspack docs. Laszlo, could you rewrite this ?
-
-1 - easy - mfx) Check whether the compressed size of the executable is
-  really smaller than the uncompressed
-
-1 - ??? - mfx) Implement a more informational interface.
-    Probably add some global functions in msg.cpp.
-    Should think about the requirements first, i.e. should there be
-    some simple hierarchies (header1, header2, ...) etc. ?
-    Could use the `-v' switch for enabling this (or `-i' ??).
-  - Something like this would be fine:  (with colors :-)
-    [Processing kernel32.dll]
-      [Import]
-        3 DLL.
-        Original size: 12345 bytes.
-        Preprocessed size: 6789 bytes.
-      [Relocations]
-        Original size: 50000 bytes.
-        Preprocessed size: 25000 bytes.
-      [Exports]
-        <warning> exports compressed (try --compress-export=0 if needed)
-      [TLS]
-        Added 56 bytes TLS data.
-        Added 5 fixup records.
-      [Resources]
-        Directory size: 1234 bytes.
-        Resource data size: 100000 bytes.
-        Compressed resources: 8 (99900 bytes).
-        Not compressed resources: 1 (100 bytes).
-
-3 - ???) delete temporary files when something wrong happens
-
-4 - easy - ml) Add a `--486' option to use bswap on the 32-bit formats.
-
-4 - easy - ml) consider removing 'sbb bp,bp' or "or ebp,-1" when not needed
-
-5 - ???) idea: --subfile=xx  compress xx. subfile: we'd need a list_subfiles
-  for this...
-
-
-FIXME: classify
-
-GOALS FOR 0.90
-==============
-
-- Provide additional NRV2D stubs for all 32-bit formats. Try to do this
-    in a generic way so that we can possibly add more algorithms.
-    Start by adding a `--nrv2d' switch.
-
-FOR 0.90
-========
-
-/ update the output of `--help'
-
-- filters: implement the missing scan() function for f_cto32.
-    Maybe could use this to try to find an optimal filter (e.g.
-    if level >= 9) based on the counts.
-
-- filters: could we have use for a f->firstcall info field ?
-
-TODO
-====
-
-- all formats: more thoroughly test the exe-header in canPack()
-  and throw exceptions when encountering bad values.
-
-- experiment with filters
-
-- for small programs (e.g. < 64k) try an additional algorithm (like
-  the non yet finished NRV2C) to see if it gives better compression ?
-
-/ make checkerg++ work -> test
-
-- fix file extension handling when the --coff option is set
-
-- set up an "official" test suite
-
-- finish documentation
-

doc/.cvsignore

@@ -1,6 +0,0 @@
-upx.1
-upx.doc
-upx.html
-upx.man
-upx.ps
-upx.tex

doc/BUGS.txt

@@ -8,9 +8,8 @@
 
 
                     The Ultimate Packer for eXecutables
-          Copyright (c) 1996-2000 Markus Oberhumer & Laszlo Molnar
-               http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
-                            http://upx.tsx.org
+   Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
+                           https://upx.github.io
 
 
 Limitations and other things which are not (yet) supported:
@@ -29,7 +28,7 @@ dos/exe
 watcom/le
 ---------
  * 16-bit selector alias fixups
- * 16-bit offset relocation for objects larger than 4 kB
+ * 16-bit offset relocation for objects larger than 4 KiB
  * 16:16 fixups
 
 If you need any of the above (they're very rare), send us an URL of a
@@ -45,8 +44,7 @@ test file.
 
 win32/pe
 --------
- * writeable shared sections (`--force' *may* work)
+ * writable shared sections (`--force' *may* work)
  * certificates in the image
  * compressing files which contain a big BSS requires lots of memory
    during compression
-

doc/Makefile

@@ -1,68 +1,71 @@
-SHELL = /bin/sh
+#
+# UPX doc Makefile - needs GNU make, pod2html, pod2man and pod2text
+#
 
-top_srcdir = ..
+BUILT_SOURCES = upx.1 upx-doc.html upx-doc.txt
+
+top_srcdir ?= ..
 
 PACKAGE       = upx
-VERSION_DATE = 20 Dec 2000
-VERSION     := $(shell sed -n 's/^.*UPX_VERSION_STRING.*"\(.*\)".*/\1/p' $(top_srcdir)/src/version.h)
+VERSION_DATE := $(shell sed -n 's/^.*UPX_VERSION_DATE_ISO .*"\(.*\)".*/\1/p' $(top_srcdir)/src/version.h)
+VERSION      := $(shell sed -n 's/^.*UPX_VERSION_STRING .*"\(.*\)".*/\1/p' $(top_srcdir)/src/version.h)
 
-TRIMSPACE = cat
-TRIMSPACE = sed -e 's/ *$$//'
+# internal make variables
+comma := ,
+empty :=
+space := $(empty) $(empty)
+tab   := $(empty)	$(empty)
 
-BUILT_SOURCES = upx.1 upx.doc upx.html upx.man upx.ps upx.tex
-BUILT_SOURCES = upx.1 upx.doc upx.html upx.man
+RTRIM  := sed -e 's/[ $(tab)]*$$//'
+DETAB2 := sed -e 's/$(tab)/  /g'
 
+#***********************************************************************
+# targets
+#***********************************************************************
 
-###
-###
-###
+.DEFAULT_GOAL = all
 
-all: $(BUILT_SOURCES)
+all: $(BUILT_SOURCES) PHONY
 
-mostlyclean:
-	-rm -f $(BUILT_SOURCES) pod2htm*
+mostlyclean clean distclean maintainer-clean: PHONY
+	rm -f $(BUILT_SOURCES) ./pod2htm*
 
-clean: mostlyclean
+#***********************************************************************
+# rules
+#***********************************************************************
 
-distclean: clean
+.SUFFIXES:
+.SUFFIXES: .1 .html .man .pod .ps .tex .txt
 
-maintainer-clean: distclean
+%.1 : %.pod
+	pod2man --center=" " --release="$(PACKAGE) $(VERSION)" --date="$(VERSION_DATE)" $< | $(RTRIM) > $@
+	test -s $@
 
-.SUFFIXES: .1 .doc .html .man .pod .ps .tex .texi
+%-doc.html : %.pod
+	pod2html --noindex $< | $(RTRIM) | $(DETAB2) > $@
+	@rm -f ./pod2htm*
+	test -s $@
 
-.PHONY: all mostlyclean clean distclean maintainer-clean
+%.man : %.1
+	nroff -man $< | $(RTRIM) > $@
+	test -s $@
 
+%.ps : %.1
+	groff -man $< | $(RTRIM) > $@
+	test -s $@
 
-###
-### rules
-###
-
-.pod.1:
-	pod2man --center=" " --release="$(PACKAGE) $(VERSION)" --date="$(VERSION_DATE)" $< | $(TRIMSPACE) > $@
-
-.pod.html:
-###	pod2html $< | $(TRIMSPACE) > $@
-	pod2html --noindex $< | $(TRIMSPACE) > $@
-	@-rm -f pod2htm*
-
-.pod.tex:
+%.tex : %.pod
 	pod2latex $<
+	test -s $@
 
-.pod.doc:
-	pod2text < $< | $(TRIMSPACE) > $@
+%-doc.txt : %.pod
+	pod2text < $< | $(RTRIM) > $@
+	test -s $@
 
-.1.man:
-	nroff -man $< | $(TRIMSPACE) > $@
-
-.1.ps:
-	groff -man $< | $(TRIMSPACE) > $@
-
-
-###
-### dependencies
-###
-
-$(BUILT_SOURCES): $(top_srcdir)/src/version.h Makefile
-
-.NOEXPORT:
+#***********************************************************************
+# dependencies
+#***********************************************************************
 
+$(BUILT_SOURCES): $(top_srcdir)/src/version.h $(MAKEFILE_LIST)
+.DELETE_ON_ERROR: $(BUILT_SOURCES)
+.PHONY: PHONY

doc/THANKS.txt

@@ -8,9 +8,8 @@
 
 
                     The Ultimate Packer for eXecutables
-          Copyright (c) 1996-2000 Markus Oberhumer & Laszlo Molnar
-               http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
-                            http://upx.tsx.org
+   Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
+                           https://upx.github.io
 
 
 .___..        .
@@ -40,21 +39,24 @@ Ice
   for debugging the PE headersize problem down
 Joergen Ibsen <jibz@hotmail.com> and d'b
   for the relocation & address optimization ideas
-John F. Reiser <jreiser@BitWagon.com>
-  for the new Linux executable formats
 John S. Fine <johnfine@erols.com>
   for the new version of the dos/exe decompressor
+Kornel Pal
+  for the EFI support
 Lukundoo <Lukundoo@softhome.net>
   for beta testing
+Michael Devore
+  for initial dos/exe device driver support
 Oleg V. Volkov <rover@lglobus.ru>
-  for various FreeBSD specific informations
+  for various FreeBSD specific information
 The Owl & G-RoM
   for the --compress-icons fix
 Ralph Roth <RalphRoth@gmx.net>
   for reporting several bugs
 Salvador Eduardo Tropea
   for beta testing
-The WINE project (http://www.winehq.com/)
+Stefan Widmann
+  for the win32/pe TLS callback support
+The WINE project (https://www.winehq.com/)
   for lots of useful information found in their PE loader sources
 Natascha
-

doc/elf-to-mem.txt

@@ -1,5 +1,5 @@
            Decompressing ELF Directly to Memory on Linux/x86
-          Copyright 2000 John F. Reiser  jreiser@BitWagon.com
+        Copyright (C) 2000-2023 John F. Reiser  jreiser@BitWagon.com
 
 References:
   <elf.h>   definitions for the ELF file format
@@ -17,7 +17,7 @@ program itself.  So, the decompressor program (which contains the
 compressed version of the original executable) must have the same
 brk() as the original executable.  So, the second PT_LOAD
 ELF "segment" of the compressed program is used only to set the brk(0).
-See src/p_lx_elf.cpp, function PackLinuxI386elf::patchLoader().
+See src/p_lx_elf.cpp, function PackLinuxElf32::generateElfHdr.
 All of the decompressor's code, and all of the compressed image
 of the original executable, reside in the first PT_LOAD of the
 decompressor program.
@@ -46,8 +46,8 @@ may not be used to take the address of a function.
 
 The address  0x00400000 was chosen to be out of the way of the usual
 load address 0x08048000, and to minimize fragmentation in kernel
-page tables; one page of page tables covers 4MB. The address
-0x00401000 was chosen as 1 page up from a 64KB boundary, to
+page tables; one page of page tables covers 4 MiB. The address
+0x00401000 was chosen as 1 page up from a 64 KiB boundary, to
 make the startup code and its constants smaller.
 
 Decompression of the executable begins by decompressing the Elf32_Ehdr
@@ -57,9 +57,51 @@ Subroutine do_xmap() of src/stub/l_lx_elf.c performs the
 "virtual execve()" using the compressed data as source, and stores
 the decompressed bytes directly into the appropriate virtual addresses.
 
-Before transfering control to the PT_INTERP "program interpreter",
+Before transferring control to the PT_INTERP "program interpreter",
 minor tricks are required to setup the Elf32_auxv_t entries,
 clear the free portion of the stack (to compensate for ld-linux.so.2
 assuming that its automatic stack variables are initialized to zero),
 and remove (all but 4 bytes of) the decompression program (and
 compressed executable) from the address space.
+
+As of upx-3.05, by default on Linux, upon decompression then one page
+of the compressed executable remains mapped into the address space
+of the process.  If all of the pages of the compressed executable are
+unmapped, then the Linux kernel erases the symlink /proc/self/exe,
+and this can cause trouble for the runtime shared library loader
+expanding $ORIGIN in -rpath, or for application code that relies on
+/proc/self/exe.  Use the compress-time command-line option
+--unmap-all-pages to achieve that effect at run time.  Upx-3.04
+and previous versions did this by default with no option.  However,
+too much other software erroneously assumes that /proc/self/exe
+always exists.
+
+On arm*-linux-elf there is no good address at which to retain one
+page of the compressed executable.  Pages below the usual .p_vaddr
+0x8000 (32KiB) are rejected by the kernel.  Using a page above the
+original uncompressed brk(0) would require placing the entire initial
+compressed program above uncompressed brk(0), which would significantly
+increase the running brk(0); but too many programs break if brk(0)
+moves.  Thus on arm*-linux-elf the compressed executable begins
+with 0x8000==.p_vaddr, all pages mapped by execve() that are also
+occupied by decompressed bytes are removed before overwriting, and
+/proc/self/exe becomes a "(deleted)" symlink.  It might be possible
+to preserve /proc/self/exe if the original uncompressed executable
+were created with 0x9000==.p_vaddr (one page higher than the usual
+0x8000) so that the compressed page mapped at 0x8000 would linger.
+[This has not been tested.]
+
+Linux stores the pathname argument that was specified to execve()
+immediately after the '\0' which terminates the character string of the
+last environment variable [as of execve()].  This is true for at least
+all Linux 2.6, 2.4, and 2.2 kernels.  Linux kernel 2.6.29 and later
+records a pointer to that character string in Elf32_auxv[AT_EXECFN].
+The pathname is not "bound" to the file as strongly as /proc/self/exe
+(the file may be changed without affecting the pathname), but the
+pathname does provide some information.  The pathname may be relative
+to the working directory, so look before any chdir().
+
+The Elf formats for Linux add an environment variable named "   " [three
+spaces] which saves the results of readlink("/proc/self/exe",,) before
+the runtime stub unmaps all its pages.  As of 2006-10-03 this works
+for linux/elf386 and linux/ElfAMD.

doc/filter.txt

@@ -108,14 +108,14 @@ then skip another one - the unfiltering process needs some information
 to be able to reverse the filtering.
 
 UPX uses the following idea, which works nicely. First we assume that
-the size of the area that should be filtered is less than 16MB. Then
+the size of the area that should be filtered is less than 16 MiB. Then
 UPX scans over this area and keeps a record of the bytes that are
 following the 0xE8 bytes. If we are lucky, there will be bytes that
 were not found following 0xE8. These bytes are our candidates to be
 used as markers.
 
 Do you still remember that we assumed that the size of scanned area is
-less than 16MB? Well, this means that when we process a real call, the
+less than 16 MiB? Well, this means that when we process a real call, the
 resulting offset will be less than 0x00FFFFFF too. So the MSB is always
 0x00. Which is a nice place to store our marker. Of course we should
 reverse the byte order in the resulting offset - so this marker will

doc/linker.txt

@@ -0,0 +1,50 @@
+This documentation is written for those brave souls who want to
+understand and/or modify the UPX assembly stubs - the small snippets
+that do the runtime decompression when a compressed program is started.
+
+If you look at the C++ source files, you can find code fragments like
+this:
+
+    addLoader("PEMAIN20",
+              ih.entry ? "PEDOJUMP" : "PERETURN",
+              "IDENTSTR""UPX1HEAD",
+              NULL
+             );
+
+    linker->defineSymbol("original_entry", ih.entry);
+
+and in the assembly files fragments like this:
+
+    section         PEISDLL1
+                    cmpb    [esp + 8], 1
+                    jnz     reloc_end_jmp
+
+    section         PEMAIN21
+    reloc_end_jmp:
+
+    section         PERETURN
+                    xor     eax, eax
+                    inc     eax
+                    ret     0x0C
+    section         PEDOJUMP
+                    jmp    original_entry
+
+Everything works as you would expect. If you want to add the code
+fragment which is in `section PERETURN' to the runtime stub, then
+simply use `addLoader("PERETURN")' in the C++ source.
+
+That's nice, you could say, but how cross section jumps and calls are
+handled? Well, that is the nicest part of this stuff - they are handled
+automatically. All you have to do is to add the required sections to the
+loader using `addLoader()' and the rest is done by upx. It will resolve
+every conditional or unconditional jumps or subroutine calls for you.
+
+You can also use (undefined) symbols in the assembly for values that
+can only be computed during compression time (like `original_entry').
+These symbols can be defined later in C++ using
+
+        linker->defineSymbol("xx", yy)
+
+This functionality (we could say it's a simple linker) is achieved by
+compiling the assembly into an ELF object file which a little C++
+module (src/linker.cpp) can interpret and work with.

doc/loader.txt

@@ -1,89 +0,0 @@
-This documentation was written for those brave souls who want to
-understand and/or modify the UPX assembly stubs - the small snippets
-that do the runtime decompression when a compressed program is started.
-
-So, how the runtime stub/loader generation works?
-
-You might have already noticed that for some file formats the loaders
-are quite simple (linux/i386 & tos) while in the other cases the
-loaders look very suspicious: they're full of `%ifdef's and contain
-loads of cryptic comments like `__PERELOC2__'.
-
-If you look at the C++ source files, however you can notice that these
-comment strings (without the leading and trailing underscores) are used
-in the following way (they are all 8 character length strings):
-
-    addLoader("PEMAIN20",
-              ih.entry ? "PEDOJUMP" : "PERETURN",
-              "IDENTSTR""UPX1HEAD",
-              NULL
-             );
-
-Basically that's all you have to know: when you want to add a section
-of assembly code to the runtime loader, you just write
-
-l_foo.asm
----------
-    ;__FOOBAR00__
-
-    xor eax, eax
-    label1:
-    jmps label1
-
-    ;__FOOBARZZ__
-
-p_foo.cpp
----------
-
-    addLoader("FOOBAR00", NULL);
-
-This will add the assembly section starting from __FOOBAR00__ and ending
-before __FOOBARZZ__ to the loader. You can add an %ifdef - %endif pair
-before these comments if you wish - but these conditionals will NOT be
-seen by the assembler, they are just syntactic sugar to make the code a
-little bit more readable and understandable. (Note however, that only
-%ifdefs which are started on the 1st column are removed by the upx
-assembly preprocessor program, so you can still use preprocessor
-conditionals if you wish - just write them starting from the 2nd
-column.)
-
-That's nice, you could say, but how cross section jumps and calls are
-handled? Well, that is the nicest part of this stuff - they are handled
-automatically. All you have to do is to add the required sections to the
-loader using `addLoader()' and the rest is done by upx. It will resolve
-every conditional or unconditional jumps or subrutine calls for you.
-
-This functionality (we could say it's a simple linker) is achived by the
-assembly preprocessor (src/stub/scripts/app.pl) and a little C++ module
-(src/linker.cpp). And of course NASM - the Netwide Assembler. You can
-see what's going on behind the scenes - just do:
-
-    cd src/stubs
-    make maintainer-clean
-    make all
-
-This will rebuild all the loaders - and keep the temporary files (*.as[xy])
-which are seen by the assembler.
-
-Currently this loader/stub building method only works with ix86
-assembly - both app.pl and linker.cpp heavily rely on this when dealing
-with cross section references.
-
-And finally some important features/requirements you should be aware of:
-
- - as previously stated - preprocessor conditionals starting on the 1st
-   column are removed by app.pl
- - sections are separated by comments in the form `;__X1234567__'
- - jumps are recognized by searching for a word which starts with `j'
-   and followed by a label - this also means that `jmp short label1'
-   will NOT be recognized (but you can use a macro called `jmps' for it
-   by adding `%define jmps jmp short' to the beginning of the file)
- - at the end of the file you need something like this
-
-    eof:
-    ;       __XTHEENDX__
-            section .data
-            dd      -1
-            dw      eof
-
-That's all for now.

doc/selinux.txt

@@ -0,0 +1,43 @@
+                        UPX and SELinux
+                        March 6, 2006
+
+
+When a program that has been compressed by UPX is run, the decompressor
+must create and write new memory pages of executable instructions.
+SELinux (Security Enhanced Linux) directly controls the conditions
+under which generating and/or executing new instructions is allowed,
+so the configuration settings of SELinux affect the running of programs
+that have been compressed by UPX.
+
+In SELinux "strict enforcing" mode (the most restrictive), generating
+new instructions at runtime is not allowed at all: any page with
+PROT_EXEC permission must be mapped from a file in a mounted filesystem
+that has 'x' [eXecute] permission, and the generation of such files is
+also tightly controlled.  A program that was compressed by UPX will not
+run in SELinux strict enforcing mode.  Attempts will fail with exit
+code 127, and a record will be added to the history file
+/var/log/audit/audit.log.
+
+In "targeted enforcing" mode, SELinux pays close attention mostly to
+designated processes that run with elevated privileges: web server,
+print server, login server, etc.  Ordinary user executables receive
+much less scrutiny.  However, one of the eventual goals of SELinux is to
+eradicate runtime generation of instructions because of the possibility
+for exploitation by malware (virus, trojan, key logger, privilege
+elevation exploit, etc.)  Thus targeted enforcing mode notices and
+logs the use of "execmem" capability that is used by a program which
+was compressed by UPX.  In keeping with the goal of eventual prohibition,
+SELinux ordinarily would deny execmem.  However, most current SELinux
+systems, including Fedora Core 5 [set for release March 15, 2006],
+override this with "allow_exemem=1" in /etc/selinux/targeted/booleans.
+Thus a program compressed by UPX will run in the default installed
+configuration (targeted enforcing, allow_execmem=1) of SELinux under
+Fedora Core 5.  Each invocation will add a few lines to the log file
+/var/log/audit/audit.log, one line for each use of execmem.  If the
+SELinux policy becomes more restrictive in the future, then a special
+SELinux class or other mechanism must be created for compressed programs,
+or else UPX-compressed executables will not run then.
+
+In its "permissive" modes, SELinux just logs the potential problems,
+but otherwise does not interfere.  A program compressed by UPX will run
+in any permissive mode.

doc/upx-doc.html

@@ -0,0 +1,807 @@
+<?xml version="1.0" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>upx - compress or expand executable files</title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body>
+
+
+
+<h1 id="NAME">NAME</h1>
+
+<p>upx - compress or expand executable files</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<p><b>upx</b> <span style="white-space: nowrap;">[ <i>command</i> ]</span> <span style="white-space: nowrap;">[ <i>options</i> ]</span> <i>filename</i>...</p>
+
+<h1 id="ABSTRACT">ABSTRACT</h1>
+
+<pre><code>                 The Ultimate Packer for eXecutables
+Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar &amp; John Reiser
+                        https://upx.github.io</code></pre>
+
+<p><b>UPX</b> is a portable, extendable, high-performance executable packer for several different executable formats. It achieves an excellent compression ratio and offers <i>*very*</i> fast decompression. Your executables suffer no memory overhead or other drawbacks for most of the formats supported, because of in-place decompression.</p>
+
+<h1 id="DISCLAIMER">DISCLAIMER</h1>
+
+<p><b>UPX</b> comes with ABSOLUTELY NO WARRANTY; for details see the file COPYING.</p>
+
+<p>Please report all problems or suggestions to the authors. Thanks.</p>
+
+<h1 id="SECURITY-CONTEXT">SECURITY CONTEXT</h1>
+
+<p>IMPORTANT NOTE: <b>UPX</b> inherits the security context of any files it handles.</p>
+
+<p>This means that packing, unpacking, or even testing or listing a file requires the same security considerations as actually executing the file.</p>
+
+<p>Use <b>UPX</b> on trusted files only!</p>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p><b>UPX</b> is a versatile executable packer with the following features:</p>
+
+<pre><code>- secure: as UPX is documented Open Source since many years any relevant
+    Security/Antivirus software is able to peek inside UPX compressed
+    apps to verify them
+
+- excellent compression ratio: typically compresses better than Zip,
+    use UPX to decrease the size of your distribution !
+
+- very fast decompression: more than 500 MB/sec on any reasonably modern
+    machine
+
+- no memory overhead for your compressed executables for most of the
+    supported formats because of in-place decompression
+
+- safe: you can list, test and unpack your executables.
+    Also, a checksum of both the compressed and uncompressed file is
+    maintained internally.
+
+- universal: UPX can pack a number of executable formats, including
+    Windows programs and DLLs, macOS apps and Linux executables
+
+- portable: UPX is written in portable endian-neutral C++
+
+- extendable: because of the class layout it&#39;s very easy to support
+    new executable formats or add new compression algorithms
+
+- free: UPX is distributed with full source code under the GNU General
+    Public License v2+, with special exceptions granting the free usage
+    for commercial programs</code></pre>
+
+<p>You probably understand now why we call <b>UPX</b> the &quot;<i>ultimate</i>&quot; executable packer.</p>
+
+<h1 id="COMMANDS">COMMANDS</h1>
+
+<h2 id="Compress">Compress</h2>
+
+<p>This is the default operation, eg. <b>upx yourfile.exe</b> will compress the file specified on the command line.</p>
+
+<h2 id="Decompress">Decompress</h2>
+
+<p>All <b>UPX</b> supported file formats can be unpacked using the <b>-d</b> switch, eg. <b>upx -d yourfile.exe</b> will uncompress the file you&#39;ve just compressed.</p>
+
+<h2 id="Test">Test</h2>
+
+<p>The <b>-t</b> command tests the integrity of the compressed and uncompressed data, eg. <b>upx -t yourfile.exe</b> check whether your file can be safely decompressed. Note, that this command doesn&#39;t check the whole file, only the part that will be uncompressed during program execution. This means that you should not use this command instead of a virus checker.</p>
+
+<h2 id="List">List</h2>
+
+<p>The <b>-l</b> command prints out some information about the compressed files specified on the command line as parameters, eg <b>upx -l yourfile.exe</b> shows the compressed / uncompressed size and the compression ratio of <i>yourfile.exe</i>.</p>
+
+<h1 id="OPTIONS">OPTIONS</h1>
+
+<p><b>-q</b>: be quiet, suppress warnings</p>
+
+<p><b>-q -q</b> (or <b>-qq</b>): be very quiet, suppress errors</p>
+
+<p><b>-q -q -q</b> (or <b>-qqq</b>): produce no output at all</p>
+
+<p><b>--help</b>: prints the help</p>
+
+<p><b>--version</b>: print the version of <b>UPX</b></p>
+
+<p><b>--exact</b>: when compressing, require to be able to get a byte-identical file after decompression with option <b>-d</b>. [NOTE: this is work in progress and is not supported for all formats yet. If you do care, as a workaround you can compress and then decompress your program a first time - any further compress-decompress steps should then yield byte-identical results as compared to the first decompressed version.]</p>
+
+<p><b>-k</b>: keep backup files</p>
+
+<p><b>-o file</b>: write output to file</p>
+
+<p>[ ...more docs need to be written... - type `<b>upx --help</b>&#39; for now ]</p>
+
+<h1 id="COMPRESSION-LEVELS-TUNING">COMPRESSION LEVELS &amp; TUNING</h1>
+
+<p><b>UPX</b> offers ten different compression levels from <b>-1</b> to <b>-9</b>, and <b>--best</b>. The default compression level is <b>-8</b> for files smaller than 512 KiB, and <b>-7</b> otherwise.</p>
+
+<ul>
+
+<li><p>Compression levels 1, 2 and 3 are pretty fast.</p>
+
+</li>
+<li><p>Compression levels 4, 5 and 6 achieve a good time/ratio performance.</p>
+
+</li>
+<li><p>Compression levels 7, 8 and 9 favor compression ratio over speed.</p>
+
+</li>
+<li><p>Compression level <b>--best</b> may take a long time.</p>
+
+</li>
+</ul>
+
+<p>Note that compression level <b>--best</b> can be somewhat slow for large files, but you definitely should use it when releasing a final version of your program.</p>
+
+<p>Quick info for achieving the best compression ratio:</p>
+
+<ul>
+
+<li><p>Try <b>upx --brute --no-lzma myfile.exe</b> or even <b>upx --ultra-brute --no-lzma myfile.exe</b>.</p>
+
+</li>
+<li><p>The option <b>--lzma</b> enables LZMA compression, which compresses better but is *significantly slower* at decompression. You probably do not want to use it for large files.</p>
+
+<p>(Note that <b>--lzma</b> is automatically enabled by <b>--all-methods</b> and <b>--brute</b>, use <b>--no-lzma</b> to override.)</p>
+
+</li>
+<li><p>Try if <b>--overlay=strip</b> works.</p>
+
+</li>
+<li><p>For win32/pe programs there&#39;s <b>--strip-relocs=0</b>. See notes below.</p>
+
+</li>
+</ul>
+
+<h1 id="OVERLAY-HANDLING-OPTIONS">OVERLAY HANDLING OPTIONS</h1>
+
+<p>Info: An &quot;overlay&quot; means auxiliary data attached after the logical end of an executable, and it often contains application specific data (this is a common practice to avoid an extra data file, though it would be better to use resource sections).</p>
+
+<p><b>UPX</b> handles overlays like many other executable packers do: it simply copies the overlay after the compressed image. This works with some files, but doesn&#39;t work with others, depending on how an application actually accesses this overlaid data.</p>
+
+<pre><code>--overlay=copy    Copy any extra data attached to the file. [DEFAULT]
+
+--overlay=strip   Strip any overlay from the program instead of
+                  copying it. Be warned, this may make the compressed
+                  program crash or otherwise unusable.
+
+--overlay=skip    Refuse to compress any program which has an overlay.</code></pre>
+
+<h1 id="ENVIRONMENT-VARIABLE">ENVIRONMENT VARIABLE</h1>
+
+<p>The environment variable <b>UPX</b> can hold a set of default options for <b>UPX</b>. These options are interpreted first and can be overwritten by explicit command line parameters. For example:</p>
+
+<pre><code>for DOS/Windows:   set UPX=-9 --compress-icons#0
+for sh/ksh/zsh:    UPX=&quot;-9 --compress-icons=0&quot;; export UPX
+for csh/tcsh:      setenv UPX &quot;-9 --compress-icons=0&quot;</code></pre>
+
+<p>Under DOS/Windows you must use &#39;#&#39; instead of &#39;=&#39; when setting the environment variable because of a COMMAND.COM limitation.</p>
+
+<p>Not all of the options are valid in the environment variable - <b>UPX</b> will tell you.</p>
+
+<p>You can explicitly use the <b>--no-env</b> option to ignore the environment variable.</p>
+
+<h1 id="NOTES-FOR-THE-SUPPORTED-EXECUTABLE-FORMATS">NOTES FOR THE SUPPORTED EXECUTABLE FORMATS</h1>
+
+<h2 id="NOTES-FOR-ATARI-TOS">NOTES FOR ATARI/TOS</h2>
+
+<p>This is the executable format used by the Atari ST/TT, a Motorola 68000 based personal computer which was popular in the late &#39;80s. Support of this format is only because of nostalgic feelings of one of the authors and serves no practical purpose :-). See https://freemint.github.io for more info.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression. All debug information will be stripped, though.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-BVMLINUZ-I386">NOTES FOR BVMLINUZ/I386</h2>
+
+<p>Same as vmlinuz/i386.</p>
+
+<h2 id="NOTES-FOR-DOS-COM">NOTES FOR DOS/COM</h2>
+
+<p>Obviously <b>UPX</b> won&#39;t work with executables that want to read data from themselves (like some commandline utilities that ship with Win95/98/ME).</p>
+
+<p>Compressed programs only work on a 286+.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression.</p>
+
+<p>Maximum uncompressed size: ~65100 bytes.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--8086              Create an executable that works on any 8086 CPU.
+
+--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--all-filters       Compress the program several times, using all
+                    available preprocessing filters. This may improve
+                    the compression ratio in some cases, but usually
+                    the default filter gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-DOS-EXE">NOTES FOR DOS/EXE</h2>
+
+<p>dos/exe stands for all &quot;normal&quot; 16-bit DOS executables.</p>
+
+<p>Obviously <b>UPX</b> won&#39;t work with executables that want to read data from themselves (like some command line utilities that ship with Win95/98/ME).</p>
+
+<p>Compressed programs only work on a 286+.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--8086              Create an executable that works on any 8086 CPU.
+
+--no-reloc          Use no relocation records in the exe header.
+
+--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-DOS-SYS">NOTES FOR DOS/SYS</h2>
+
+<p>Compressed programs only work on a 286+.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression.</p>
+
+<p>Maximum uncompressed size: ~65350 bytes.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--8086              Create an executable that works on any 8086 CPU.
+
+--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--all-filters       Compress the program several times, using all
+                    available preprocessing filters. This may improve
+                    the compression ratio in some cases, but usually
+                    the default filter gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-DJGPP2-COFF">NOTES FOR DJGPP2/COFF</h2>
+
+<p>First of all, it is recommended to use <b>UPX</b> *instead* of <b>strip</b>. strip has the very bad habit of replacing your stub with its own (outdated) version. Additionally <b>UPX</b> corrects a bug/feature in strip v2.8.x: it will fix the 4 KiB alignment of the stub.</p>
+
+<p><b>UPX</b> includes the full functionality of stubify. This means it will automatically stubify your COFF files. Use the option <b>--coff</b> to disable this functionality (see below).</p>
+
+<p><b>UPX</b> automatically handles Allegro packfiles.</p>
+
+<p>The DLM format (a rather exotic shared library extension) is not supported.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression. All debug information and trailing garbage will be stripped, though.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--coff              Produce COFF output instead of EXE. By default
+                    UPX keeps your current stub.
+
+--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--all-filters       Compress the program several times, using all
+                    available preprocessing filters. This may improve
+                    the compression ratio in some cases, but usually
+                    the default filter gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-LINUX-general">NOTES FOR LINUX [general]</h2>
+
+<p>Introduction</p>
+
+<pre><code>Linux/386 support in UPX consists of 3 different executable formats,
+one optimized for ELF executables (&quot;linux/elf386&quot;), one optimized
+for shell scripts (&quot;linux/sh386&quot;), and one generic format
+(&quot;linux/386&quot;).
+
+We will start with a general discussion first, but please
+also read the relevant docs for each of the individual formats.
+
+Also, there is special support for bootable kernels - see the
+description of the vmlinuz/386 format.</code></pre>
+
+<p>General user&#39;s overview</p>
+
+<pre><code>Running a compressed executable program trades less space on a
+``permanent&#39;&#39; storage medium (such as a hard disk, floppy disk,
+CD-ROM, flash memory, EPROM, etc.) for more space in one or more
+``temporary&#39;&#39; storage media (such as RAM, swap space, /tmp, etc.).
+Running a compressed executable also requires some additional CPU
+cycles to generate the compressed executable in the first place,
+and to decompress it at each invocation.
+
+How much space is traded?  It depends on the executable, but many
+programs save 30% to 50% of permanent disk space.  How much CPU
+overhead is there?  Again, it depends on the executable, but
+decompression speed generally is at least many megabytes per second,
+and frequently is limited by the speed of the underlying disk
+or network I/O.
+
+Depending on the statistics of usage and access, and the relative
+speeds of CPU, RAM, swap space, /tmp, and file system storage, then
+invoking and running a compressed executable can be faster than
+directly running the corresponding uncompressed program.
+The operating system might perform fewer expensive I/O operations
+to invoke the compressed program.  Paging to or from swap space
+or /tmp might be faster than paging from the general file system.
+``Medium-sized&#39;&#39; programs which access about 1/3 to 1/2 of their
+stored program bytes can do particularly well with compression.
+Small programs tend not to benefit as much because the absolute
+savings is less.  Big programs tend not to benefit proportionally
+because each invocation may use only a small fraction of the program,
+yet UPX decompresses the entire program before invoking it.
+But in environments where disk or flash memory storage is limited,
+then compression may win anyway.
+
+Currently, executables compressed by UPX do not share RAM at runtime
+in the way that executables mapped from a file system do.  As a
+result, if the same program is run simultaneously by more than one
+process, then using the compressed version will require more RAM and/or
+swap space.  So, shell programs (bash, csh, etc.)  and ``make&#39;&#39;
+might not be good candidates for compression.
+
+UPX recognizes three executable formats for Linux: Linux/elf386,
+Linux/sh386, and Linux/386.  Linux/386 is the most generic format;
+it accommodates any file that can be executed.  At runtime, the UPX
+decompression stub re-creates in /tmp a copy of the original file,
+and then the copy is (re-)executed with the same arguments.
+ELF binary executables prefer the Linux/elf386 format by default,
+because UPX decompresses them directly into RAM, uses only one
+exec, does not use space in /tmp, and does not use /proc.
+Shell scripts where the underlying shell accepts a ``-c&#39;&#39; argument
+can use the Linux/sh386 format.  UPX decompresses the shell script
+into low memory, then maps the shell and passes the entire text of the
+script as an argument with a leading ``-c&#39;&#39;.</code></pre>
+
+<p>General benefits:</p>
+
+<pre><code>- UPX can compress all executables, be it AOUT, ELF, libc4, libc5,
+  libc6, Shell/Perl/Python/... scripts, standalone Java .class
+  binaries, or whatever...
+  All scripts and programs will work just as before.
+
+- Compressed programs are completely self-contained. No need for
+  any external program.
+
+- UPX keeps your original program untouched. This means that
+  after decompression you will have a byte-identical version,
+  and you can use UPX as a file compressor just like gzip.
+  [ Note that UPX maintains a checksum of the file internally,
+    so it is indeed a reliable alternative. ]
+
+- As the stub only uses syscalls and isn&#39;t linked against libc it
+  should run under any Linux configuration that can run ELF
+  binaries.
+
+- For the same reason compressed executables should run under
+  FreeBSD and other systems which can run Linux binaries.
+  [ Please send feedback on this topic ]</code></pre>
+
+<p>General drawbacks:</p>
+
+<pre><code>- It is not advisable to compress programs which usually have many
+  instances running (like `sh&#39; or `make&#39;) because the common segments of
+  compressed programs won&#39;t be shared any longer between different
+  processes.
+
+- `ldd&#39; and `size&#39; won&#39;t show anything useful because all they
+  see is the statically linked stub.  Since version 0.82 the section
+  headers are stripped from the UPX stub and `size&#39; doesn&#39;t even
+  recognize the file format.  The file patches/patch-elfcode.h has a
+  patch to fix this bug in `size&#39; and other programs which use GNU BFD.</code></pre>
+
+<p>General notes:</p>
+
+<pre><code>- As UPX leaves your original program untouched it is advantageous
+  to strip it before compression.
+
+- If you compress a script you will lose platform independence -
+  this could be a problem if you are using NFS mounted disks.
+
+- Compression of suid, guid and sticky-bit programs is rejected
+  because of possible security implications.
+
+- For the same reason there is no sense in making any compressed
+  program suid.
+
+- Obviously UPX won&#39;t work with executables that want to read data
+  from themselves. E.g., this might be a problem for Perl scripts
+  which access their __DATA__ lines.
+
+- In case of internal errors the stub will abort with exitcode 127.
+  Typical reasons for this to happen are that the program has somehow
+  been modified after compression.
+  Running `strace -o strace.log compressed_file&#39; will tell you more.</code></pre>
+
+<h2 id="NOTES-FOR-LINUX-ELF386">NOTES FOR LINUX/ELF386</h2>
+
+<p>Please read the general Linux description first.</p>
+
+<p>The linux/elf386 format decompresses directly into RAM, uses only one exec, does not use space in /tmp, and does not use /proc.</p>
+
+<p>Linux/elf386 is automatically selected for Linux ELF executables.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression.</p>
+
+<p>How it works:</p>
+
+<pre><code>For ELF executables, UPX decompresses directly to memory, simulating
+the mapping that the operating system kernel uses during exec(),
+including the PT_INTERP program interpreter (if any).
+The brk() is set by a special PT_LOAD segment in the compressed
+executable itself.  UPX then wipes the stack clean except for
+arguments, environment variables, and Elf_auxv entries (this is
+required by bugs in the startup code of /lib/ld-linux.so as of
+May 2000), and transfers control to the program interpreter or
+the e_entry address of the original executable.
+
+The UPX stub is about 1700 bytes long, partly written in assembler
+and only uses kernel syscalls. It is not linked against any libc.</code></pre>
+
+<p>Specific drawbacks:</p>
+
+<pre><code>- For linux/elf386 and linux/sh386 formats, you will be relying on
+  RAM and swap space to hold all of the decompressed program during
+  the lifetime of the process.  If you already use most of your swap
+  space, then you may run out.  A system that is &quot;out of memory&quot;
+  can become fragile.  Many programs do not react gracefully when
+  malloc() returns 0.  With newer Linux kernels, the kernel
+  may decide to kill some processes to regain memory, and you
+  may not like the kernel&#39;s choice of which to kill.  Running
+  /usr/bin/top is one way to check on the usage of swap space.</code></pre>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>(none)</code></pre>
+
+<h2 id="NOTES-FOR-LINUX-SH386">NOTES FOR LINUX/SH386</h2>
+
+<p>Please read the general Linux description first.</p>
+
+<p>Shell scripts where the underling shell accepts a ``-c&#39;&#39; argument can use the Linux/sh386 format. <b>UPX</b> decompresses the shell script into low memory, then maps the shell and passes the entire text of the script as an argument with a leading ``-c&#39;&#39;. It does not use space in /tmp, and does not use /proc.</p>
+
+<p>Linux/sh386 is automatically selected for shell scripts that use a known shell.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression.</p>
+
+<p>How it works:</p>
+
+<pre><code>For shell script executables (files beginning with &quot;#!/&quot; or &quot;#! /&quot;)
+where the shell is known to accept &quot;-c &lt;command&gt;&quot;, UPX decompresses
+the file into low memory, then maps the shell (and its PT_INTERP),
+and passes control to the shell with the entire decompressed file
+as the argument after &quot;-c&quot;.  Known shells are sh, ash, bash, bsh, csh,
+ksh, tcsh, pdksh.  Restriction: UPX cannot use this method
+for shell scripts which use the one optional string argument after
+the shell name in the script (example: &quot;#! /bin/sh option3\n&quot;.)
+
+The UPX stub is about 1700 bytes long, partly written in assembler
+and only uses kernel syscalls. It is not linked against any libc.</code></pre>
+
+<p>Specific drawbacks:</p>
+
+<pre><code>- For linux/elf386 and linux/sh386 formats, you will be relying on
+  RAM and swap space to hold all of the decompressed program during
+  the lifetime of the process.  If you already use most of your swap
+  space, then you may run out.  A system that is &quot;out of memory&quot;
+  can become fragile.  Many programs do not react gracefully when
+  malloc() returns 0.  With newer Linux kernels, the kernel
+  may decide to kill some processes to regain memory, and you
+  may not like the kernel&#39;s choice of which to kill.  Running
+  /usr/bin/top is one way to check on the usage of swap space.</code></pre>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>(none)</code></pre>
+
+<h2 id="NOTES-FOR-LINUX-386">NOTES FOR LINUX/386</h2>
+
+<p>Please read the general Linux description first.</p>
+
+<p>The generic linux/386 format decompresses to /tmp and needs /proc file system support. It starts the decompressed program via the execve() syscall.</p>
+
+<p>Linux/386 is only selected if the specialized linux/elf386 and linux/sh386 won&#39;t recognize a file.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression.</p>
+
+<p>How it works:</p>
+
+<pre><code>For files which are not ELF and not a script for a known &quot;-c&quot; shell,
+UPX uses kernel execve(), which first requires decompressing to a
+temporary file in the file system.  Interestingly -
+because of the good memory management of the Linux kernel - this
+often does not introduce a noticeable delay, and in fact there
+will be no disk access at all if you have enough free memory as
+the entire process takes places within the file system buffers.
+
+A compressed executable consists of the UPX stub and an overlay
+which contains the original program in a compressed form.
+
+The UPX stub is a statically linked ELF executable and does
+the following at program startup:
+
+  1) decompress the overlay to a temporary location in /tmp
+  2) open the temporary file for reading
+  3) try to delete the temporary file and start (execve)
+     the uncompressed program in /tmp using /proc/&lt;pid&gt;/fd/X as
+     attained by step 2)
+  4) if that fails, fork off a subprocess to clean up and
+     start the program in /tmp in the meantime
+
+The UPX stub is about 1700 bytes long, partly written in assembler
+and only uses kernel syscalls. It is not linked against any libc.</code></pre>
+
+<p>Specific drawbacks:</p>
+
+<pre><code>- You need additional free disk space for the uncompressed program
+  in your /tmp directory. This program is deleted immediately after
+  decompression, but you still need it for the full execution time
+  of the program.
+
+- You must have /proc file system support as the stub wants to open
+  /proc/&lt;pid&gt;/exe and needs /proc/&lt;pid&gt;/fd/X. This also means that you
+  cannot compress programs that are used during the boot sequence
+  before /proc is mounted.
+
+- Utilities like `top&#39; will display numerical values in the process
+  name field. This is because Linux computes the process name from
+  the first argument of the last execve syscall (which is typically
+  something like /proc/&lt;pid&gt;/fd/3).
+
+- Because of temporary decompression to disk the decompression speed
+  is not as fast as with the other executable formats. Still, I can see
+  no noticeable delay when starting programs like my ~3 MiB emacs (which
+  is less than 1 MiB when compressed :-).</code></pre>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--force-execve      Force the use of the generic linux/386 &quot;execve&quot;
+                    format, i.e. do not try the linux/elf386 and
+                    linux/sh386 formats.</code></pre>
+
+<h2 id="NOTES-FOR-PS1-EXE">NOTES FOR PS1/EXE</h2>
+
+<p>This is the executable format used by the Sony PlayStation (PSone), a MIPS R3000 based gaming console which is popular since the late &#39;90s. Support of this format is very similar to the Atari one, because of nostalgic feelings of one of the authors.</p>
+
+<p>Packed programs will be byte-identical to the original after uncompression, until further notice.</p>
+
+<p>Maximum uncompressed size: ~1.89 / ~7.60 MiB.</p>
+
+<p>Notes:</p>
+
+<pre><code>- UPX creates as default a suitable executable for CD-Mastering
+  and console transfer. For a CD-Master main executable you could also try
+  the special option &quot;--boot-only&quot; as described below.
+  It has been reported that upx packed executables are fully compatible with
+  the Sony PlayStation 2 (PS2, PStwo) and Sony PlayStation Portable (PSP) in
+  Sony PlayStation (PSone) emulation mode.
+
+- Normally the packed files use the same memory areas like the uncompressed
+  versions, so they will not override other memory areas while unpacking.
+  If this isn&#39;t possible UPX will abort showing a &#39;packed data overlap&#39;
+  error. With the &quot;--force&quot; option UPX will relocate the loading address
+  for the packed file, but this isn&#39;t a real problem if it is a single or
+  the main executable.</code></pre>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--8-bit             Uses 8 bit size compression [default: 32 bit]
+
+--8mib-ram          PSone has 8 MiB ram available [default: 2 MiB]
+
+--boot-only         This format is for main exes and CD-Mastering only !
+                    It may slightly improve the compression ratio,
+                    decompression routines are faster than default ones.
+                    But it cannot be used for console transfer !
+
+--no-align          This option disables CD mode 2 data sector format
+                    alignment. May slightly improves the compression ratio,
+                    but the compressed executable will not boot from a CD.
+                    Use it for console transfer only !</code></pre>
+
+<h2 id="NOTES-FOR-RTM32-PE-and-ARM-PE">NOTES FOR RTM32/PE and ARM/PE</h2>
+
+<p>Same as win32/pe.</p>
+
+<h2 id="NOTES-FOR-TMT-ADAM">NOTES FOR TMT/ADAM</h2>
+
+<p>This format is used by the TMT Pascal compiler - see http://www.tmt.com/ .</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--all-filters       Compress the program several times, using all
+                    available preprocessing filters. This may improve
+                    the compression ratio in some cases, but usually
+                    the default filter gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-VMLINUZ-386">NOTES FOR VMLINUZ/386</h2>
+
+<p>The vmlinuz/386 and bvmlinuz/386 formats take a gzip-compressed bootable Linux kernel image (&quot;vmlinuz&quot;, &quot;zImage&quot;, &quot;bzImage&quot;), gzip-decompress it and re-compress it with the <b>UPX</b> compression method.</p>
+
+<p>vmlinuz/386 is completely unrelated to the other Linux executable formats, and it does not share any of their drawbacks.</p>
+
+<p>Notes:</p>
+
+<pre><code>- Be sure that &quot;vmlinuz/386&quot; or &quot;bvmlinuz/386&quot; is displayed
+during compression - otherwise a wrong executable format
+may have been used, and the kernel won&#39;t boot.</code></pre>
+
+<p>Benefits:</p>
+
+<pre><code>- Better compression (but note that the kernel was already compressed,
+so the improvement is not as large as with other formats).
+Still, the bytes saved may be essential for special needs like
+boot disks.
+
+   For example, this is what I get for my 2.2.16 kernel:
+      1589708  vmlinux
+       641073  bzImage        [original]
+       560755  bzImage.upx    [compressed by &quot;upx -9&quot;]
+
+- Much faster decompression at kernel boot time (but kernel
+  decompression speed is not really an issue these days).</code></pre>
+
+<p>Drawbacks:</p>
+
+<pre><code>(none)</code></pre>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--all-methods       Compress the program several times, using all
+                    available compression methods. This may improve
+                    the compression ratio in some cases, but usually
+                    the default method gives the best results anyway.
+
+--all-filters       Compress the program several times, using all
+                    available preprocessing filters. This may improve
+                    the compression ratio in some cases, but usually
+                    the default filter gives the best results anyway.</code></pre>
+
+<h2 id="NOTES-FOR-WATCOM-LE">NOTES FOR WATCOM/LE</h2>
+
+<p><b>UPX</b> has been successfully tested with the following extenders: DOS4G, DOS4GW, PMODE/W, DOS32a, CauseWay. The WDOS/X extender is partly supported (for details see the file bugs BUGS).</p>
+
+<p>DLLs and the LX format are not supported.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--le                Produce an unbound LE output instead of
+                    keeping the current stub.</code></pre>
+
+<h2 id="NOTES-FOR-WIN32-PE">NOTES FOR WIN32/PE</h2>
+
+<p>The PE support in <b>UPX</b> is quite stable now, but probably there are still some incompatibilities with some files.</p>
+
+<p>Because of the way <b>UPX</b> (and other packers for this format) works, you can see increased memory usage of your compressed files because the whole program is loaded into memory at startup. If you start several instances of huge compressed programs you&#39;re wasting memory because the common segments of the program won&#39;t get shared across the instances. On the other hand if you&#39;re compressing only smaller programs, or running only one instance of larger programs, then this penalty is smaller, but it&#39;s still there.</p>
+
+<p>If you&#39;re running executables from network, then compressed programs will load faster, and require less bandwidth during execution.</p>
+
+<p>DLLs are supported. But UPX compressed DLLs can not share common data and code when they got used by multiple applications. So compressing msvcrt.dll is a waste of memory, but compressing the dll plugins of a particular application may be a better idea.</p>
+
+<p>Screensavers are supported, with the restriction that the filename must end with &quot;.scr&quot; (as screensavers are handled slightly different than normal exe files).</p>
+
+<p>UPX compressed PE files have some minor memory overhead (usually in the 10 - 30 KiB range) which can be seen by specifying the &quot;-i&quot; command line switch during compression.</p>
+
+<p>Extra options available for this executable format:</p>
+
+<pre><code>--compress-exports=0 Don&#39;t compress the export section.
+                     Use this if you plan to run the compressed
+                     program under Wine.
+--compress-exports=1 Compress the export section. [DEFAULT]
+                     Compression of the export section can improve the
+                     compression ratio quite a bit but may not work
+                     with all programs (like winword.exe).
+                     UPX never compresses the export section of a DLL
+                     regardless of this option.
+
+ --compress-icons=0  Don&#39;t compress any icons.
+ --compress-icons=1  Compress all but the first icon.
+ --compress-icons=2  Compress all icons which are not in the
+                     first icon directory. [DEFAULT]
+ --compress-icons=3  Compress all icons.
+
+ --compress-resources=0  Don&#39;t compress any resources at all.
+
+ --keep-resource=list Don&#39;t compress resources specified by the list.
+                     The members of the list are separated by commas.
+                     A list member has the following format: I&lt;type[/name]&gt;.
+                     I&lt;Type&gt; is the type of the resource. Standard types
+                     must be specified as decimal numbers, user types can be
+                     specified by decimal IDs or strings. I&lt;Name&gt; is the
+                     identifier of the resource. It can be a decimal number
+                     or a string. For example:
+
+                     --keep-resource=2/MYBITMAP,5,6/12345
+
+                     UPX won&#39;t compress the named bitmap resource &quot;MYBITMAP&quot;,
+                     it leaves every dialog (5) resource uncompressed, and
+                     it won&#39;t touch the string table resource with identifier
+                     12345.
+
+ --force             Force compression even when there is an
+                     unexpected value in a header field.
+                     Use with care.
+
+ --strip-relocs=0    Don&#39;t strip relocation records.
+ --strip-relocs=1    Strip relocation records. [DEFAULT]
+                     This option only works on executables with base
+                     address greater or equal to 0x400000. Usually the
+                     compressed files becomes smaller, but some files
+                     may become larger. Note that the resulting file will
+                     not work under Windows 3.x (Win32s).
+                     UPX never strips relocations from a DLL
+                     regardless of this option.
+
+ --all-methods       Compress the program several times, using all
+                     available compression methods. This may improve
+                     the compression ratio in some cases, but usually
+                     the default method gives the best results anyway.
+
+ --all-filters       Compress the program several times, using all
+                     available preprocessing filters. This may improve
+                     the compression ratio in some cases, but usually
+                     the default filter gives the best results anyway.</code></pre>
+
+<h1 id="DIAGNOSTICS">DIAGNOSTICS</h1>
+
+<p>Exit status is normally 0; if an error occurs, exit status is 1. If a warning occurs, exit status is 2.</p>
+
+<p><b>UPX</b>&#39;s diagnostics are intended to be self-explanatory.</p>
+
+<h1 id="BUGS">BUGS</h1>
+
+<p>Please report all bugs immediately to the authors.</p>
+
+<h1 id="AUTHORS">AUTHORS</h1>
+
+<pre><code>Markus F.X.J. Oberhumer &lt;markus@oberhumer.com&gt;
+http://www.oberhumer.com
+
+Laszlo Molnar &lt;ezerotven+github@gmail.com&gt;
+
+John F. Reiser &lt;jreiser@BitWagon.com&gt;
+
+Jens Medoch &lt;jssg@users.sourceforge.net&gt;</code></pre>
+
+<h1 id="COPYRIGHT">COPYRIGHT</h1>
+
+<p>Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer</p>
+
+<p>Copyright (C) 1996-2023 Laszlo Molnar</p>
+
+<p>Copyright (C) 2000-2023 John F. Reiser</p>
+
+<p>Copyright (C) 2002-2023 Jens Medoch</p>
+
+<p><b>UPX</b> is distributed with full source code under the terms of the GNU General Public License v2+; either under the pure GPLv2+ (see the file COPYING), or (at your option) under the GPLv+2 with special exceptions and restrictions granting the free usage for all binaries including commercial programs (see the file LICENSE).</p>
+
+<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</p>
+
+<p>You should have received a copy of the UPX License Agreements along with this program; see the files COPYING and LICENSE. If not, visit the UPX home page.</p>
+
+
+</body>
+
+</html>
+
+

doc/upx-doc.txt

@@ -0,0 +1,842 @@
+NAME
+    upx - compress or expand executable files
+
+SYNOPSIS
+    upx [ *command* ] [ *options* ] *filename*...
+
+ABSTRACT
+                        The Ultimate Packer for eXecutables
+       Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
+                               https://upx.github.io
+
+    UPX is a portable, extendable, high-performance executable packer for
+    several different executable formats. It achieves an excellent
+    compression ratio and offers **very** fast decompression. Your
+    executables suffer no memory overhead or other drawbacks for most of the
+    formats supported, because of in-place decompression.
+
+DISCLAIMER
+    UPX comes with ABSOLUTELY NO WARRANTY; for details see the file COPYING.
+
+    Please report all problems or suggestions to the authors. Thanks.
+
+SECURITY CONTEXT
+    IMPORTANT NOTE: UPX inherits the security context of any files it
+    handles.
+
+    This means that packing, unpacking, or even testing or listing a file
+    requires the same security considerations as actually executing the
+    file.
+
+    Use UPX on trusted files only!
+
+DESCRIPTION
+    UPX is a versatile executable packer with the following features:
+
+      - secure: as UPX is documented Open Source since many years any relevant
+          Security/Antivirus software is able to peek inside UPX compressed
+          apps to verify them
+
+      - excellent compression ratio: typically compresses better than Zip,
+          use UPX to decrease the size of your distribution !
+
+      - very fast decompression: more than 500 MB/sec on any reasonably modern
+          machine
+
+      - no memory overhead for your compressed executables for most of the
+          supported formats because of in-place decompression
+
+      - safe: you can list, test and unpack your executables.
+          Also, a checksum of both the compressed and uncompressed file is
+          maintained internally.
+
+      - universal: UPX can pack a number of executable formats, including
+          Windows programs and DLLs, macOS apps and Linux executables
+
+      - portable: UPX is written in portable endian-neutral C++
+
+      - extendable: because of the class layout it's very easy to support
+          new executable formats or add new compression algorithms
+
+      - free: UPX is distributed with full source code under the GNU General
+          Public License v2+, with special exceptions granting the free usage
+          for commercial programs
+
+    You probably understand now why we call UPX the "*ultimate*" executable
+    packer.
+
+COMMANDS
+  Compress
+    This is the default operation, eg. upx yourfile.exe will compress the
+    file specified on the command line.
+
+  Decompress
+    All UPX supported file formats can be unpacked using the -d switch, eg.
+    upx -d yourfile.exe will uncompress the file you've just compressed.
+
+  Test
+    The -t command tests the integrity of the compressed and uncompressed
+    data, eg. upx -t yourfile.exe check whether your file can be safely
+    decompressed. Note, that this command doesn't check the whole file, only
+    the part that will be uncompressed during program execution. This means
+    that you should not use this command instead of a virus checker.
+
+  List
+    The -l command prints out some information about the compressed files
+    specified on the command line as parameters, eg upx -l yourfile.exe
+    shows the compressed / uncompressed size and the compression ratio of
+    *yourfile.exe*.
+
+OPTIONS
+    -q: be quiet, suppress warnings
+
+    -q -q (or -qq): be very quiet, suppress errors
+
+    -q -q -q (or -qqq): produce no output at all
+
+    --help: prints the help
+
+    --version: print the version of UPX
+
+    --exact: when compressing, require to be able to get a byte-identical
+    file after decompression with option -d. [NOTE: this is work in progress
+    and is not supported for all formats yet. If you do care, as a
+    workaround you can compress and then decompress your program a first
+    time - any further compress-decompress steps should then yield
+    byte-identical results as compared to the first decompressed version.]
+
+    -k: keep backup files
+
+    -o file: write output to file
+
+    [ ...more docs need to be written... - type `upx --help' for now ]
+
+COMPRESSION LEVELS & TUNING
+    UPX offers ten different compression levels from -1 to -9, and --best.
+    The default compression level is -8 for files smaller than 512 KiB, and
+    -7 otherwise.
+
+    *   Compression levels 1, 2 and 3 are pretty fast.
+
+    *   Compression levels 4, 5 and 6 achieve a good time/ratio performance.
+
+    *   Compression levels 7, 8 and 9 favor compression ratio over speed.
+
+    *   Compression level --best may take a long time.
+
+    Note that compression level --best can be somewhat slow for large files,
+    but you definitely should use it when releasing a final version of your
+    program.
+
+    Quick info for achieving the best compression ratio:
+
+    *   Try upx --brute --no-lzma myfile.exe or even upx --ultra-brute
+        --no-lzma myfile.exe.
+
+    *   The option --lzma enables LZMA compression, which compresses better
+        but is *significantly slower* at decompression. You probably do not
+        want to use it for large files.
+
+        (Note that --lzma is automatically enabled by --all-methods and
+        --brute, use --no-lzma to override.)
+
+    *   Try if --overlay=strip works.
+
+    *   For win32/pe programs there's --strip-relocs=0. See notes below.
+
+OVERLAY HANDLING OPTIONS
+    Info: An "overlay" means auxiliary data attached after the logical end
+    of an executable, and it often contains application specific data (this
+    is a common practice to avoid an extra data file, though it would be
+    better to use resource sections).
+
+    UPX handles overlays like many other executable packers do: it simply
+    copies the overlay after the compressed image. This works with some
+    files, but doesn't work with others, depending on how an application
+    actually accesses this overlaid data.
+
+      --overlay=copy    Copy any extra data attached to the file. [DEFAULT]
+
+      --overlay=strip   Strip any overlay from the program instead of
+                        copying it. Be warned, this may make the compressed
+                        program crash or otherwise unusable.
+
+      --overlay=skip    Refuse to compress any program which has an overlay.
+
+ENVIRONMENT VARIABLE
+    The environment variable UPX can hold a set of default options for UPX.
+    These options are interpreted first and can be overwritten by explicit
+    command line parameters. For example:
+
+        for DOS/Windows:   set UPX=-9 --compress-icons#0
+        for sh/ksh/zsh:    UPX="-9 --compress-icons=0"; export UPX
+        for csh/tcsh:      setenv UPX "-9 --compress-icons=0"
+
+    Under DOS/Windows you must use '#' instead of '=' when setting the
+    environment variable because of a COMMAND.COM limitation.
+
+    Not all of the options are valid in the environment variable - UPX will
+    tell you.
+
+    You can explicitly use the --no-env option to ignore the environment
+    variable.
+
+NOTES FOR THE SUPPORTED EXECUTABLE FORMATS
+  NOTES FOR ATARI/TOS
+    This is the executable format used by the Atari ST/TT, a Motorola 68000
+    based personal computer which was popular in the late '80s. Support of
+    this format is only because of nostalgic feelings of one of the authors
+    and serves no practical purpose :-). See https://freemint.github.io for
+    more info.
+
+    Packed programs will be byte-identical to the original after
+    uncompression. All debug information will be stripped, though.
+
+    Extra options available for this executable format:
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+  NOTES FOR BVMLINUZ/I386
+    Same as vmlinuz/i386.
+
+  NOTES FOR DOS/COM
+    Obviously UPX won't work with executables that want to read data from
+    themselves (like some commandline utilities that ship with Win95/98/ME).
+
+    Compressed programs only work on a 286+.
+
+    Packed programs will be byte-identical to the original after
+    uncompression.
+
+    Maximum uncompressed size: ~65100 bytes.
+
+    Extra options available for this executable format:
+
+      --8086              Create an executable that works on any 8086 CPU.
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+  NOTES FOR DOS/EXE
+    dos/exe stands for all "normal" 16-bit DOS executables.
+
+    Obviously UPX won't work with executables that want to read data from
+    themselves (like some command line utilities that ship with
+    Win95/98/ME).
+
+    Compressed programs only work on a 286+.
+
+    Extra options available for this executable format:
+
+      --8086              Create an executable that works on any 8086 CPU.
+
+      --no-reloc          Use no relocation records in the exe header.
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+  NOTES FOR DOS/SYS
+    Compressed programs only work on a 286+.
+
+    Packed programs will be byte-identical to the original after
+    uncompression.
+
+    Maximum uncompressed size: ~65350 bytes.
+
+    Extra options available for this executable format:
+
+      --8086              Create an executable that works on any 8086 CPU.
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+  NOTES FOR DJGPP2/COFF
+    First of all, it is recommended to use UPX *instead* of strip. strip has
+    the very bad habit of replacing your stub with its own (outdated)
+    version. Additionally UPX corrects a bug/feature in strip v2.8.x: it
+    will fix the 4 KiB alignment of the stub.
+
+    UPX includes the full functionality of stubify. This means it will
+    automatically stubify your COFF files. Use the option --coff to disable
+    this functionality (see below).
+
+    UPX automatically handles Allegro packfiles.
+
+    The DLM format (a rather exotic shared library extension) is not
+    supported.
+
+    Packed programs will be byte-identical to the original after
+    uncompression. All debug information and trailing garbage will be
+    stripped, though.
+
+    Extra options available for this executable format:
+
+      --coff              Produce COFF output instead of EXE. By default
+                          UPX keeps your current stub.
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+  NOTES FOR LINUX [general]
+    Introduction
+
+      Linux/386 support in UPX consists of 3 different executable formats,
+      one optimized for ELF executables ("linux/elf386"), one optimized
+      for shell scripts ("linux/sh386"), and one generic format
+      ("linux/386").
+
+      We will start with a general discussion first, but please
+      also read the relevant docs for each of the individual formats.
+
+      Also, there is special support for bootable kernels - see the
+      description of the vmlinuz/386 format.
+
+    General user's overview
+
+      Running a compressed executable program trades less space on a
+      ``permanent'' storage medium (such as a hard disk, floppy disk,
+      CD-ROM, flash memory, EPROM, etc.) for more space in one or more
+      ``temporary'' storage media (such as RAM, swap space, /tmp, etc.).
+      Running a compressed executable also requires some additional CPU
+      cycles to generate the compressed executable in the first place,
+      and to decompress it at each invocation.
+
+      How much space is traded?  It depends on the executable, but many
+      programs save 30% to 50% of permanent disk space.  How much CPU
+      overhead is there?  Again, it depends on the executable, but
+      decompression speed generally is at least many megabytes per second,
+      and frequently is limited by the speed of the underlying disk
+      or network I/O.
+
+      Depending on the statistics of usage and access, and the relative
+      speeds of CPU, RAM, swap space, /tmp, and file system storage, then
+      invoking and running a compressed executable can be faster than
+      directly running the corresponding uncompressed program.
+      The operating system might perform fewer expensive I/O operations
+      to invoke the compressed program.  Paging to or from swap space
+      or /tmp might be faster than paging from the general file system.
+      ``Medium-sized'' programs which access about 1/3 to 1/2 of their
+      stored program bytes can do particularly well with compression.
+      Small programs tend not to benefit as much because the absolute
+      savings is less.  Big programs tend not to benefit proportionally
+      because each invocation may use only a small fraction of the program,
+      yet UPX decompresses the entire program before invoking it.
+      But in environments where disk or flash memory storage is limited,
+      then compression may win anyway.
+
+      Currently, executables compressed by UPX do not share RAM at runtime
+      in the way that executables mapped from a file system do.  As a
+      result, if the same program is run simultaneously by more than one
+      process, then using the compressed version will require more RAM and/or
+      swap space.  So, shell programs (bash, csh, etc.)  and ``make''
+      might not be good candidates for compression.
+
+      UPX recognizes three executable formats for Linux: Linux/elf386,
+      Linux/sh386, and Linux/386.  Linux/386 is the most generic format;
+      it accommodates any file that can be executed.  At runtime, the UPX
+      decompression stub re-creates in /tmp a copy of the original file,
+      and then the copy is (re-)executed with the same arguments.
+      ELF binary executables prefer the Linux/elf386 format by default,
+      because UPX decompresses them directly into RAM, uses only one
+      exec, does not use space in /tmp, and does not use /proc.
+      Shell scripts where the underlying shell accepts a ``-c'' argument
+      can use the Linux/sh386 format.  UPX decompresses the shell script
+      into low memory, then maps the shell and passes the entire text of the
+      script as an argument with a leading ``-c''.
+
+    General benefits:
+
+      - UPX can compress all executables, be it AOUT, ELF, libc4, libc5,
+        libc6, Shell/Perl/Python/... scripts, standalone Java .class
+        binaries, or whatever...
+        All scripts and programs will work just as before.
+
+      - Compressed programs are completely self-contained. No need for
+        any external program.
+
+      - UPX keeps your original program untouched. This means that
+        after decompression you will have a byte-identical version,
+        and you can use UPX as a file compressor just like gzip.
+        [ Note that UPX maintains a checksum of the file internally,
+          so it is indeed a reliable alternative. ]
+
+      - As the stub only uses syscalls and isn't linked against libc it
+        should run under any Linux configuration that can run ELF
+        binaries.
+
+      - For the same reason compressed executables should run under
+        FreeBSD and other systems which can run Linux binaries.
+        [ Please send feedback on this topic ]
+
+    General drawbacks:
+
+      - It is not advisable to compress programs which usually have many
+        instances running (like `sh' or `make') because the common segments of
+        compressed programs won't be shared any longer between different
+        processes.
+
+      - `ldd' and `size' won't show anything useful because all they
+        see is the statically linked stub.  Since version 0.82 the section
+        headers are stripped from the UPX stub and `size' doesn't even
+        recognize the file format.  The file patches/patch-elfcode.h has a
+        patch to fix this bug in `size' and other programs which use GNU BFD.
+
+    General notes:
+
+      - As UPX leaves your original program untouched it is advantageous
+        to strip it before compression.
+
+      - If you compress a script you will lose platform independence -
+        this could be a problem if you are using NFS mounted disks.
+
+      - Compression of suid, guid and sticky-bit programs is rejected
+        because of possible security implications.
+
+      - For the same reason there is no sense in making any compressed
+        program suid.
+
+      - Obviously UPX won't work with executables that want to read data
+        from themselves. E.g., this might be a problem for Perl scripts
+        which access their __DATA__ lines.
+
+      - In case of internal errors the stub will abort with exitcode 127.
+        Typical reasons for this to happen are that the program has somehow
+        been modified after compression.
+        Running `strace -o strace.log compressed_file' will tell you more.
+
+  NOTES FOR LINUX/ELF386
+    Please read the general Linux description first.
+
+    The linux/elf386 format decompresses directly into RAM, uses only one
+    exec, does not use space in /tmp, and does not use /proc.
+
+    Linux/elf386 is automatically selected for Linux ELF executables.
+
+    Packed programs will be byte-identical to the original after
+    uncompression.
+
+    How it works:
+
+      For ELF executables, UPX decompresses directly to memory, simulating
+      the mapping that the operating system kernel uses during exec(),
+      including the PT_INTERP program interpreter (if any).
+      The brk() is set by a special PT_LOAD segment in the compressed
+      executable itself.  UPX then wipes the stack clean except for
+      arguments, environment variables, and Elf_auxv entries (this is
+      required by bugs in the startup code of /lib/ld-linux.so as of
+      May 2000), and transfers control to the program interpreter or
+      the e_entry address of the original executable.
+
+      The UPX stub is about 1700 bytes long, partly written in assembler
+      and only uses kernel syscalls. It is not linked against any libc.
+
+    Specific drawbacks:
+
+      - For linux/elf386 and linux/sh386 formats, you will be relying on
+        RAM and swap space to hold all of the decompressed program during
+        the lifetime of the process.  If you already use most of your swap
+        space, then you may run out.  A system that is "out of memory"
+        can become fragile.  Many programs do not react gracefully when
+        malloc() returns 0.  With newer Linux kernels, the kernel
+        may decide to kill some processes to regain memory, and you
+        may not like the kernel's choice of which to kill.  Running
+        /usr/bin/top is one way to check on the usage of swap space.
+
+    Extra options available for this executable format:
+
+      (none)
+
+  NOTES FOR LINUX/SH386
+    Please read the general Linux description first.
+
+    Shell scripts where the underling shell accepts a ``-c'' argument can
+    use the Linux/sh386 format. UPX decompresses the shell script into low
+    memory, then maps the shell and passes the entire text of the script as
+    an argument with a leading ``-c''. It does not use space in /tmp, and
+    does not use /proc.
+
+    Linux/sh386 is automatically selected for shell scripts that use a known
+    shell.
+
+    Packed programs will be byte-identical to the original after
+    uncompression.
+
+    How it works:
+
+      For shell script executables (files beginning with "#!/" or "#! /")
+      where the shell is known to accept "-c <command>", UPX decompresses
+      the file into low memory, then maps the shell (and its PT_INTERP),
+      and passes control to the shell with the entire decompressed file
+      as the argument after "-c".  Known shells are sh, ash, bash, bsh, csh,
+      ksh, tcsh, pdksh.  Restriction: UPX cannot use this method
+      for shell scripts which use the one optional string argument after
+      the shell name in the script (example: "#! /bin/sh option3\n".)
+
+      The UPX stub is about 1700 bytes long, partly written in assembler
+      and only uses kernel syscalls. It is not linked against any libc.
+
+    Specific drawbacks:
+
+      - For linux/elf386 and linux/sh386 formats, you will be relying on
+        RAM and swap space to hold all of the decompressed program during
+        the lifetime of the process.  If you already use most of your swap
+        space, then you may run out.  A system that is "out of memory"
+        can become fragile.  Many programs do not react gracefully when
+        malloc() returns 0.  With newer Linux kernels, the kernel
+        may decide to kill some processes to regain memory, and you
+        may not like the kernel's choice of which to kill.  Running
+        /usr/bin/top is one way to check on the usage of swap space.
+
+    Extra options available for this executable format:
+
+      (none)
+
+  NOTES FOR LINUX/386
+    Please read the general Linux description first.
+
+    The generic linux/386 format decompresses to /tmp and needs /proc file
+    system support. It starts the decompressed program via the execve()
+    syscall.
+
+    Linux/386 is only selected if the specialized linux/elf386 and
+    linux/sh386 won't recognize a file.
+
+    Packed programs will be byte-identical to the original after
+    uncompression.
+
+    How it works:
+
+      For files which are not ELF and not a script for a known "-c" shell,
+      UPX uses kernel execve(), which first requires decompressing to a
+      temporary file in the file system.  Interestingly -
+      because of the good memory management of the Linux kernel - this
+      often does not introduce a noticeable delay, and in fact there
+      will be no disk access at all if you have enough free memory as
+      the entire process takes places within the file system buffers.
+
+      A compressed executable consists of the UPX stub and an overlay
+      which contains the original program in a compressed form.
+
+      The UPX stub is a statically linked ELF executable and does
+      the following at program startup:
+
+        1) decompress the overlay to a temporary location in /tmp
+        2) open the temporary file for reading
+        3) try to delete the temporary file and start (execve)
+           the uncompressed program in /tmp using /proc/<pid>/fd/X as
+           attained by step 2)
+        4) if that fails, fork off a subprocess to clean up and
+           start the program in /tmp in the meantime
+
+      The UPX stub is about 1700 bytes long, partly written in assembler
+      and only uses kernel syscalls. It is not linked against any libc.
+
+    Specific drawbacks:
+
+      - You need additional free disk space for the uncompressed program
+        in your /tmp directory. This program is deleted immediately after
+        decompression, but you still need it for the full execution time
+        of the program.
+
+      - You must have /proc file system support as the stub wants to open
+        /proc/<pid>/exe and needs /proc/<pid>/fd/X. This also means that you
+        cannot compress programs that are used during the boot sequence
+        before /proc is mounted.
+
+      - Utilities like `top' will display numerical values in the process
+        name field. This is because Linux computes the process name from
+        the first argument of the last execve syscall (which is typically
+        something like /proc/<pid>/fd/3).
+
+      - Because of temporary decompression to disk the decompression speed
+        is not as fast as with the other executable formats. Still, I can see
+        no noticeable delay when starting programs like my ~3 MiB emacs (which
+        is less than 1 MiB when compressed :-).
+
+    Extra options available for this executable format:
+
+      --force-execve      Force the use of the generic linux/386 "execve"
+                          format, i.e. do not try the linux/elf386 and
+                          linux/sh386 formats.
+
+  NOTES FOR PS1/EXE
+    This is the executable format used by the Sony PlayStation (PSone), a
+    MIPS R3000 based gaming console which is popular since the late '90s.
+    Support of this format is very similar to the Atari one, because of
+    nostalgic feelings of one of the authors.
+
+    Packed programs will be byte-identical to the original after
+    uncompression, until further notice.
+
+    Maximum uncompressed size: ~1.89 / ~7.60 MiB.
+
+    Notes:
+
+      - UPX creates as default a suitable executable for CD-Mastering
+        and console transfer. For a CD-Master main executable you could also try
+        the special option "--boot-only" as described below.
+        It has been reported that upx packed executables are fully compatible with
+        the Sony PlayStation 2 (PS2, PStwo) and Sony PlayStation Portable (PSP) in
+        Sony PlayStation (PSone) emulation mode.
+
+      - Normally the packed files use the same memory areas like the uncompressed
+        versions, so they will not override other memory areas while unpacking.
+        If this isn't possible UPX will abort showing a 'packed data overlap'
+        error. With the "--force" option UPX will relocate the loading address
+        for the packed file, but this isn't a real problem if it is a single or
+        the main executable.
+
+    Extra options available for this executable format:
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --8-bit             Uses 8 bit size compression [default: 32 bit]
+
+      --8mib-ram          PSone has 8 MiB ram available [default: 2 MiB]
+
+      --boot-only         This format is for main exes and CD-Mastering only !
+                          It may slightly improve the compression ratio,
+                          decompression routines are faster than default ones.
+                          But it cannot be used for console transfer !
+
+      --no-align          This option disables CD mode 2 data sector format
+                          alignment. May slightly improves the compression ratio,
+                          but the compressed executable will not boot from a CD.
+                          Use it for console transfer only !
+
+  NOTES FOR RTM32/PE and ARM/PE
+    Same as win32/pe.
+
+  NOTES FOR TMT/ADAM
+    This format is used by the TMT Pascal compiler - see http://www.tmt.com/
+    .
+
+    Extra options available for this executable format:
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+  NOTES FOR VMLINUZ/386
+    The vmlinuz/386 and bvmlinuz/386 formats take a gzip-compressed bootable
+    Linux kernel image ("vmlinuz", "zImage", "bzImage"), gzip-decompress it
+    and re-compress it with the UPX compression method.
+
+    vmlinuz/386 is completely unrelated to the other Linux executable
+    formats, and it does not share any of their drawbacks.
+
+    Notes:
+
+      - Be sure that "vmlinuz/386" or "bvmlinuz/386" is displayed
+      during compression - otherwise a wrong executable format
+      may have been used, and the kernel won't boot.
+
+    Benefits:
+
+      - Better compression (but note that the kernel was already compressed,
+      so the improvement is not as large as with other formats).
+      Still, the bytes saved may be essential for special needs like
+      boot disks.
+
+         For example, this is what I get for my 2.2.16 kernel:
+            1589708  vmlinux
+             641073  bzImage        [original]
+             560755  bzImage.upx    [compressed by "upx -9"]
+
+      - Much faster decompression at kernel boot time (but kernel
+        decompression speed is not really an issue these days).
+
+    Drawbacks:
+
+      (none)
+
+    Extra options available for this executable format:
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+  NOTES FOR WATCOM/LE
+    UPX has been successfully tested with the following extenders: DOS4G,
+    DOS4GW, PMODE/W, DOS32a, CauseWay. The WDOS/X extender is partly
+    supported (for details see the file bugs BUGS).
+
+    DLLs and the LX format are not supported.
+
+    Extra options available for this executable format:
+
+      --le                Produce an unbound LE output instead of
+                          keeping the current stub.
+
+  NOTES FOR WIN32/PE
+    The PE support in UPX is quite stable now, but probably there are still
+    some incompatibilities with some files.
+
+    Because of the way UPX (and other packers for this format) works, you
+    can see increased memory usage of your compressed files because the
+    whole program is loaded into memory at startup. If you start several
+    instances of huge compressed programs you're wasting memory because the
+    common segments of the program won't get shared across the instances. On
+    the other hand if you're compressing only smaller programs, or running
+    only one instance of larger programs, then this penalty is smaller, but
+    it's still there.
+
+    If you're running executables from network, then compressed programs
+    will load faster, and require less bandwidth during execution.
+
+    DLLs are supported. But UPX compressed DLLs can not share common data
+    and code when they got used by multiple applications. So compressing
+    msvcrt.dll is a waste of memory, but compressing the dll plugins of a
+    particular application may be a better idea.
+
+    Screensavers are supported, with the restriction that the filename must
+    end with ".scr" (as screensavers are handled slightly different than
+    normal exe files).
+
+    UPX compressed PE files have some minor memory overhead (usually in the
+    10 - 30 KiB range) which can be seen by specifying the "-i" command line
+    switch during compression.
+
+    Extra options available for this executable format:
+
+     --compress-exports=0 Don't compress the export section.
+                          Use this if you plan to run the compressed
+                          program under Wine.
+     --compress-exports=1 Compress the export section. [DEFAULT]
+                          Compression of the export section can improve the
+                          compression ratio quite a bit but may not work
+                          with all programs (like winword.exe).
+                          UPX never compresses the export section of a DLL
+                          regardless of this option.
+
+      --compress-icons=0  Don't compress any icons.
+      --compress-icons=1  Compress all but the first icon.
+      --compress-icons=2  Compress all icons which are not in the
+                          first icon directory. [DEFAULT]
+      --compress-icons=3  Compress all icons.
+
+      --compress-resources=0  Don't compress any resources at all.
+
+      --keep-resource=list Don't compress resources specified by the list.
+                          The members of the list are separated by commas.
+                          A list member has the following format: I<type[/name]>.
+                          I<Type> is the type of the resource. Standard types
+                          must be specified as decimal numbers, user types can be
+                          specified by decimal IDs or strings. I<Name> is the
+                          identifier of the resource. It can be a decimal number
+                          or a string. For example:
+
+                          --keep-resource=2/MYBITMAP,5,6/12345
+
+                          UPX won't compress the named bitmap resource "MYBITMAP",
+                          it leaves every dialog (5) resource uncompressed, and
+                          it won't touch the string table resource with identifier
+                          12345.
+
+      --force             Force compression even when there is an
+                          unexpected value in a header field.
+                          Use with care.
+
+      --strip-relocs=0    Don't strip relocation records.
+      --strip-relocs=1    Strip relocation records. [DEFAULT]
+                          This option only works on executables with base
+                          address greater or equal to 0x400000. Usually the
+                          compressed files becomes smaller, but some files
+                          may become larger. Note that the resulting file will
+                          not work under Windows 3.x (Win32s).
+                          UPX never strips relocations from a DLL
+                          regardless of this option.
+
+      --all-methods       Compress the program several times, using all
+                          available compression methods. This may improve
+                          the compression ratio in some cases, but usually
+                          the default method gives the best results anyway.
+
+      --all-filters       Compress the program several times, using all
+                          available preprocessing filters. This may improve
+                          the compression ratio in some cases, but usually
+                          the default filter gives the best results anyway.
+
+DIAGNOSTICS
+    Exit status is normally 0; if an error occurs, exit status is 1. If a
+    warning occurs, exit status is 2.
+
+    UPX's diagnostics are intended to be self-explanatory.
+
+BUGS
+    Please report all bugs immediately to the authors.
+
+AUTHORS
+     Markus F.X.J. Oberhumer <markus@oberhumer.com>
+     http://www.oberhumer.com
+
+     Laszlo Molnar <ezerotven+github@gmail.com>
+
+     John F. Reiser <jreiser@BitWagon.com>
+
+     Jens Medoch <jssg@users.sourceforge.net>
+
+COPYRIGHT
+    Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+
+    Copyright (C) 1996-2023 Laszlo Molnar
+
+    Copyright (C) 2000-2023 John F. Reiser
+
+    Copyright (C) 2002-2023 Jens Medoch
+
+    UPX is distributed with full source code under the terms of the GNU
+    General Public License v2+; either under the pure GPLv2+ (see the file
+    COPYING), or (at your option) under the GPLv+2 with special exceptions
+    and restrictions granting the free usage for all binaries including
+    commercial programs (see the file LICENSE).
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+    You should have received a copy of the UPX License Agreements along with
+    this program; see the files COPYING and LICENSE. If not, visit the UPX
+    home page.
+

doc/upx.pod

@@ -13,85 +13,71 @@ B<upx> S<[ I<command> ]> S<[ I<options> ]> I<filename>...
 =head1 ABSTRACT
 
                     The Ultimate Packer for eXecutables
-          Copyright (c) 1996, 1997, 1998, 1999, 2000
-     Markus F.X.J. Oberhumer, Laszlo Molnar & John F. Reiser
-        http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
-                    http://upx.tsx.org
+   Copyright (c) 1996-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
+                           https://upx.github.io
 
 
 B<UPX> is a portable, extendable, high-performance executable packer for
 several different executable formats. It achieves an excellent compression
 ratio and offers I<*very*> fast decompression. Your executables suffer
-no memory overhead or other drawbacks for most of the formats supported.
-
-While you may use UPX freely for both non-commercial and commercial
-executables (for details see the file LICENSE), we would highly
-appreciate if you credit UPX and ourselves in the documentation,
-possibly including a reference to the UPX home page. Thanks.
-
-[ Using UPX in non-OpenSource applications without proper credits
-is considered not politically correct ;-) ]
+no memory overhead or other drawbacks for most of the formats supported,
+because of in-place decompression.
 
 
 
 =head1 DISCLAIMER
 
-UPX comes with ABSOLUTELY NO WARRANTY; for details see the file LICENSE.
-
-Having said that, we think that UPX is quite stable now. Indeed we
-have compressed lots of files without any problems. Also, the
-current version has undergone several months of beta testing -
-actually it's more than 2 1/2 years since our first public beta.
-
-This is the first production quality release, and we plan that future 1.xx
-releases will be backward compatible with this version.
+B<UPX> comes with ABSOLUTELY NO WARRANTY; for details see the file COPYING.
 
 Please report all problems or suggestions to the authors. Thanks.
 
 
 
+=head1 SECURITY CONTEXT
+
+IMPORTANT NOTE: B<UPX> inherits the security context of any files it handles.
+
+This means that packing, unpacking, or even testing or listing a file requires
+the same security considerations as actually executing the file.
+
+Use B<UPX> on trusted files only!
+
+
+
 =head1 DESCRIPTION
 
 B<UPX> is a versatile executable packer with the following features:
 
-  - excellent compression ratio: compresses better than zip/gzip,
+  - secure: as UPX is documented Open Source since many years any relevant
+      Security/Antivirus software is able to peek inside UPX compressed
+      apps to verify them
+
+  - excellent compression ratio: typically compresses better than Zip,
       use UPX to decrease the size of your distribution !
 
-  - very fast decompression: about 10 MB/sec even on my old Pentium 133
+  - very fast decompression: more than 500 MB/sec on any reasonably modern
+      machine
 
   - no memory overhead for your compressed executables for most of the
-      supported formats
+      supported formats because of in-place decompression
 
-  - safe: you can list, test and unpack your executables
+  - safe: you can list, test and unpack your executables.
       Also, a checksum of both the compressed and uncompressed file is
       maintained internally.
 
-  - universal: UPX can pack a number of executable formats:
-      * atari/tos
-      * bvmlinuz/386    [bootable Linux kernel]
-      * djgpp2/coff
-      * dos/com
-      * dos/exe
-      * dos/sys
-      * linux/386
-      * linux/elf386
-      * linux/sh386
-      * rtm32/pe
-      * tmt/adam
-      * vmlinuz/386     [bootable Linux kernel]
-      * watcom/le (supporting DOS4G, PMODE/W, DOS32a and CauseWay)
-      * win32/pe
+  - universal: UPX can pack a number of executable formats, including
+      Windows programs and DLLs, macOS apps and Linux executables
 
   - portable: UPX is written in portable endian-neutral C++
 
   - extendable: because of the class layout it's very easy to support
       new executable formats or add new compression algorithms
 
-  - free: UPX can be distributed and used freely. And from version 0.99
-      the full source code of UPX is released under the GNU General Public
-      License (GPL) !
+  - free: UPX is distributed with full source code under the GNU General
+      Public License v2+, with special exceptions granting the free usage
+      for commercial programs
 
-You probably understand now why we call UPX the "I<ultimate>"
+You probably understand now why we call B<UPX> the "I<ultimate>"
 executable packer.
 
 
@@ -105,7 +91,7 @@ specified on the command line.
 
 =head2 Decompress
 
-All UPX supported file formats can be unpacked using the B<-d> switch, eg.
+All B<UPX> supported file formats can be unpacked using the B<-d> switch, eg.
 B<upx -d yourfile.exe> will uncompress the file you've just compressed.
 
 =head2 Test
@@ -135,11 +121,20 @@ B<-q -q -q> (or B<-qqq>): produce no output at all
 
 B<--help>: prints the help
 
-B<--version>: print the version of UPX
+B<--version>: print the version of B<UPX>
 
-B<--stdout>: writes all output to stdout
+B<--exact>: when compressing, require to be able to get a byte-identical file
+after decompression with option B<-d>. [NOTE: this is work in progress and is
+not supported for all formats yet. If you do care, as a workaround you can
+compress and then decompress your program a first time - any further
+compress-decompress steps should then yield byte-identical results
+as compared to the first decompressed version.]
 
-[ ...to be written... - type `B<upx --help>' for now ]
+B<-k>: keep backup files
+
+B<-o file>: write output to file
+
+[ ...more docs need to be written... - type `B<upx --help>' for now ]
 
 
 
@@ -147,7 +142,7 @@ B<--stdout>: writes all output to stdout
 
 B<UPX> offers ten different compression levels from B<-1> to B<-9>,
 and B<--best>.  The default compression level is B<-8> for files
-smaller than 512 kB, and B<-7> otherwise.
+smaller than 512 KiB, and B<-7> otherwise.
 
 =over 4
 
@@ -169,21 +164,30 @@ Compression level B<--best> may take a long time.
 
 =back
 
-Note that compression level B<-9> can be somewhat slow for large
+Note that compression level B<--best> can be somewhat slow for large
 files, but you definitely should use it when releasing a final version
 of your program.
 
-Since UPX 0.70 there is also an extra compression level B<--best> which
-squeezes out even some more compression ratio. While it is usually fine
-to use this option with your favorite .com file it may take a long time
-to compress a multi-megabyte program. You have been warned.
-
-Tips for even better compression:
+Quick info for achieving the best compression ratio:
 
 =over 4
 
 =item *
 
+Try B<upx --brute --no-lzma myfile.exe> or even
+B<upx --ultra-brute --no-lzma myfile.exe>.
+
+=item *
+
+The option B<--lzma> enables LZMA compression, which compresses better but
+is *significantly slower* at decompression. You probably do not want
+to use it for large files.
+
+(Note that B<--lzma> is automatically enabled by B<--all-methods> and
+B<--brute>, use B<--no-lzma> to override.)
+
+=item *
+
 Try if B<--overlay=strip> works.
 
 =item *
@@ -196,12 +200,15 @@ For win32/pe programs there's B<--strip-relocs=0>. See notes below.
 
 =head1 OVERLAY HANDLING OPTIONS
 
+Info: An "overlay" means auxiliary data attached after the logical end of
+an executable, and it often contains application specific data
+(this is a common practice to avoid an extra data file, though
+it would be better to use resource sections).
+
 B<UPX> handles overlays like many other executable packers do: it simply
 copies the overlay after the compressed image. This works with some
-files, but doesn't work with others.
-
-Since version 0.90 UPX defaults to B<--overlay=copy> for
-all executable formats.
+files, but doesn't work with others, depending on how an application
+actually accesses this overlaid data.
 
   --overlay=copy    Copy any extra data attached to the file. [DEFAULT]
 
@@ -213,28 +220,25 @@ all executable formats.
 
 
 
-=head1 ENVIRONMENT
+=head1 ENVIRONMENT VARIABLE
 
 The environment variable B<UPX> can hold a set of default
-options for UPX. These options are interpreted first and
+options for B<UPX>. These options are interpreted first and
 can be overwritten by explicit command line parameters.
 For example:
 
-    for DOS/Windows:   set UPX=-9 --compress-icons#1
-    for sh/ksh/zsh:    UPX="-9 --compress-icons=1"; export UPX
-    for csh/tcsh:      setenv UPX "-9 --compress-icons=1"
+    for DOS/Windows:   set UPX=-9 --compress-icons#0
+    for sh/ksh/zsh:    UPX="-9 --compress-icons=0"; export UPX
+    for csh/tcsh:      setenv UPX "-9 --compress-icons=0"
 
 Under DOS/Windows you must use '#' instead of '=' when setting the
 environment variable because of a COMMAND.COM limitation.
 
-On Vax/VMS, the name of the environment variable is
-UPX_OPT, to avoid a conflict with the symbol set for
-invocation of the program.
-
 Not all of the options are valid in the environment variable -
-UPX will tell you.
+B<UPX> will tell you.
 
-You can use the B<--no-env> option to turn this support off.
+You can explicitly use the B<--no-env> option to ignore the
+environment variable.
 
 
 
@@ -242,17 +246,21 @@ You can use the B<--no-env> option to turn this support off.
 
 =head2 NOTES FOR ATARI/TOS
 
-This is the executable format used by the Atari ST/TT, a 68000 based
-personal computer which was popular in the late '80s. Support
+This is the executable format used by the Atari ST/TT, a Motorola 68000
+based personal computer which was popular in the late '80s. Support
 of this format is only because of nostalgic feelings of one of
 the authors and serves no practical purpose :-).
+See https://freemint.github.io for more info.
 
 Packed programs will be byte-identical to the original after uncompression.
 All debug information will be stripped, though.
 
 Extra options available for this executable format:
 
-  (none)
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
 
 
 
@@ -264,7 +272,7 @@ Same as vmlinuz/i386.
 
 =head2 NOTES FOR DOS/COM
 
-Obviously UPX won't work with executables that want to read data from
+Obviously B<UPX> won't work with executables that want to read data from
 themselves (like some commandline utilities that ship with Win95/98/ME).
 
 Compressed programs only work on a 286+.
@@ -277,13 +285,23 @@ Extra options available for this executable format:
 
   --8086              Create an executable that works on any 8086 CPU.
 
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
+
 
 
 =head2 NOTES FOR DOS/EXE
 
 dos/exe stands for all "normal" 16-bit DOS executables.
 
-Obviously UPX won't work with executables that want to read data from
+Obviously B<UPX> won't work with executables that want to read data from
 themselves (like some command line utilities that ship with Win95/98/ME).
 
 Compressed programs only work on a 286+.
@@ -294,13 +312,15 @@ Extra options available for this executable format:
 
   --no-reloc          Use no relocation records in the exe header.
 
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
 
 
 =head2 NOTES FOR DOS/SYS
 
-You can only compress plain sys files, sys/exe (two in one)
-combos are not supported.
-
 Compressed programs only work on a 286+.
 
 Packed programs will be byte-identical to the original after uncompression.
@@ -311,33 +331,51 @@ Extra options available for this executable format:
 
   --8086              Create an executable that works on any 8086 CPU.
 
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
+
 
 
 =head2 NOTES FOR DJGPP2/COFF
 
-First of all, it is recommended to use UPX *instead* of B<strip>. strip has
+First of all, it is recommended to use B<UPX> *instead* of B<strip>. strip has
 the very bad habit of replacing your stub with its own (outdated) version.
-Additionally UPX corrects a bug/feature in strip v2.8.x: it
-will fix the 4 KByte aligment of the stub.
+Additionally B<UPX> corrects a bug/feature in strip v2.8.x: it
+will fix the 4 KiB alignment of the stub.
 
-UPX includes the full functionality of stubify. This means it will
+B<UPX> includes the full functionality of stubify. This means it will
 automatically stubify your COFF files. Use the option B<--coff> to
-disable this behaviour (see below).
+disable this functionality (see below).
 
-UPX automatically handles Allegro packfiles.
+B<UPX> automatically handles Allegro packfiles.
 
 The DLM format (a rather exotic shared library extension) is not supported.
 
 Packed programs will be byte-identical to the original after uncompression.
 All debug information and trailing garbage will be stripped, though.
 
-BTW, UPX is the successor of the DJP executable packer.
-
 Extra options available for this executable format:
 
   --coff              Produce COFF output instead of EXE. By default
                       UPX keeps your current stub.
 
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
+
 
 
 =head2 NOTES FOR LINUX [general]
@@ -345,7 +383,7 @@ Extra options available for this executable format:
 Introduction
 
   Linux/386 support in UPX consists of 3 different executable formats,
-  one optimized for ELF excutables ("linux/elf386"), one optimized
+  one optimized for ELF executables ("linux/elf386"), one optimized
   for shell scripts ("linux/sh386"), and one generic format
   ("linux/386").
 
@@ -373,14 +411,14 @@ General user's overview
   or network I/O.
 
   Depending on the statistics of usage and access, and the relative
-  speeds of CPU, RAM, swap space, /tmp, and filesystem storage, then
+  speeds of CPU, RAM, swap space, /tmp, and file system storage, then
   invoking and running a compressed executable can be faster than
   directly running the corresponding uncompressed program.
-  The operating system might perfrom fewer expensive I/O operations
+  The operating system might perform fewer expensive I/O operations
   to invoke the compressed program.  Paging to or from swap space
-  or /tmp might be faster than paging from the general filesystem.
+  or /tmp might be faster than paging from the general file system.
   ``Medium-sized'' programs which access about 1/3 to 1/2 of their
-  stored program bytes can do particulary well with compression.
+  stored program bytes can do particularly well with compression.
   Small programs tend not to benefit as much because the absolute
   savings is less.  Big programs tend not to benefit proportionally
   because each invocation may use only a small fraction of the program,
@@ -389,7 +427,7 @@ General user's overview
   then compression may win anyway.
 
   Currently, executables compressed by UPX do not share RAM at runtime
-  in the way that executables mapped from a filesystem do.  As a
+  in the way that executables mapped from a file system do.  As a
   result, if the same program is run simultaneously by more than one
   process, then using the compressed version will require more RAM and/or
   swap space.  So, shell programs (bash, csh, etc.)  and ``make''
@@ -478,7 +516,7 @@ The linux/elf386 format decompresses directly into RAM,
 uses only one exec, does not use space in /tmp,
 and does not use /proc.
 
-Linux/elf386 is automatically selected for Linux ELF exectuables.
+Linux/elf386 is automatically selected for Linux ELF executables.
 
 Packed programs will be byte-identical to the original after uncompression.
 
@@ -520,7 +558,7 @@ Extra options available for this executable format:
 Please read the general Linux description first.
 
 Shell scripts where the underling shell accepts a ``-c'' argument
-can use the Linux/sh386 format.  UPX decompresses the shell script
+can use the Linux/sh386 format.  B<UPX> decompresses the shell script
 into low memory, then maps the shell and passes the entire text of the
 script as an argument with a leading ``-c''.
 It does not use space in /tmp, and does not use /proc.
@@ -566,8 +604,9 @@ Extra options available for this executable format:
 
 Please read the general Linux description first.
 
-The generic linux/386 format deompresses to /tmp
-and needs /proc filesystem support.
+The generic linux/386 format decompresses to /tmp and needs
+/proc file system support. It starts the decompressed program
+via the execve() syscall.
 
 Linux/386 is only selected if the specialized linux/elf386
 and linux/sh386 won't recognize a file.
@@ -577,12 +616,12 @@ Packed programs will be byte-identical to the original after uncompression.
 How it works:
 
   For files which are not ELF and not a script for a known "-c" shell,
-  UPX uses kernel exec(), which first requires decompressing to a
-  temporary file in the filesystem.  Interestingly -
+  UPX uses kernel execve(), which first requires decompressing to a
+  temporary file in the file system.  Interestingly -
   because of the good memory management of the Linux kernel - this
-  often does not introduce a noticable delay, and in fact there
+  often does not introduce a noticeable delay, and in fact there
   will be no disk access at all if you have enough free memory as
-  the entire process takes places within the filesystem buffers.
+  the entire process takes places within the file system buffers.
 
   A compressed executable consists of the UPX stub and an overlay
   which contains the original program in a compressed form.
@@ -608,7 +647,7 @@ Specific drawbacks:
     decompression, but you still need it for the full execution time
     of the program.
 
-  - You must have /proc filesystem support as the stub wants to open
+  - You must have /proc file system support as the stub wants to open
     /proc/<pid>/exe and needs /proc/<pid>/fd/X. This also means that you
     cannot compress programs that are used during the boot sequence
     before /proc is mounted.
@@ -620,16 +659,69 @@ Specific drawbacks:
 
   - Because of temporary decompression to disk the decompression speed
     is not as fast as with the other executable formats. Still, I can see
-    no noticable delay when starting programs like my ~3 MB emacs (which
-    is less than 1 MB when compressed :-).
+    no noticeable delay when starting programs like my ~3 MiB emacs (which
+    is less than 1 MiB when compressed :-).
 
 Extra options available for this executable format:
 
-  (none)
+  --force-execve      Force the use of the generic linux/386 "execve"
+                      format, i.e. do not try the linux/elf386 and
+                      linux/sh386 formats.
 
 
 
-=head2 NOTES FOR RTM32/PE
+=head2 NOTES FOR PS1/EXE
+
+This is the executable format used by the Sony PlayStation (PSone),
+a MIPS R3000 based gaming console which is popular since the late '90s.
+Support of this format is very similar to the Atari one, because of
+nostalgic feelings of one of the authors.
+
+Packed programs will be byte-identical to the original after uncompression,
+until further notice.
+
+Maximum uncompressed size: ~1.89 / ~7.60 MiB.
+
+Notes:
+
+  - UPX creates as default a suitable executable for CD-Mastering
+    and console transfer. For a CD-Master main executable you could also try
+    the special option "--boot-only" as described below.
+    It has been reported that upx packed executables are fully compatible with
+    the Sony PlayStation 2 (PS2, PStwo) and Sony PlayStation Portable (PSP) in
+    Sony PlayStation (PSone) emulation mode.
+
+  - Normally the packed files use the same memory areas like the uncompressed
+    versions, so they will not override other memory areas while unpacking.
+    If this isn't possible UPX will abort showing a 'packed data overlap'
+    error. With the "--force" option UPX will relocate the loading address
+    for the packed file, but this isn't a real problem if it is a single or
+    the main executable.
+
+Extra options available for this executable format:
+
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --8-bit             Uses 8 bit size compression [default: 32 bit]
+
+  --8mib-ram          PSone has 8 MiB ram available [default: 2 MiB]
+
+  --boot-only         This format is for main exes and CD-Mastering only !
+                      It may slightly improve the compression ratio,
+                      decompression routines are faster than default ones.
+                      But it cannot be used for console transfer !
+
+  --no-align          This option disables CD mode 2 data sector format
+                      alignment. May slightly improves the compression ratio,
+                      but the compressed executable will not boot from a CD.
+                      Use it for console transfer only !
+
+
+
+=head2 NOTES FOR RTM32/PE and ARM/PE
 
 Same as win32/pe.
 
@@ -641,15 +733,23 @@ This format is used by the TMT Pascal compiler - see http://www.tmt.com/ .
 
 Extra options available for this executable format:
 
-  (none)
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
 
 
 
 =head2 NOTES FOR VMLINUZ/386
 
 The vmlinuz/386 and bvmlinuz/386 formats take a gzip-compressed
-bootable kernel image ("vmlinuz", "zImage", "bzImage"), gzip-decompress
-it and re-compress it with the UPX compression method.
+bootable Linux kernel image ("vmlinuz", "zImage", "bzImage"),
+gzip-decompress it and re-compress it with the B<UPX> compression method.
 
 vmlinuz/386 is completely unrelated to the other Linux executable
 formats, and it does not share any of their drawbacks.
@@ -665,14 +765,15 @@ Benefits:
   - Better compression (but note that the kernel was already compressed,
   so the improvement is not as large as with other formats).
   Still, the bytes saved may be essential for special needs like
-  bootdisks.
+  boot disks.
 
      For example, this is what I get for my 2.2.16 kernel:
         1589708  vmlinux
          641073  bzImage        [original]
          560755  bzImage.upx    [compressed by "upx -9"]
 
-  - Much faster decompression at kernel boot time.
+  - Much faster decompression at kernel boot time (but kernel
+    decompression speed is not really an issue these days).
 
 Drawbacks:
 
@@ -680,22 +781,26 @@ Drawbacks:
 
 Extra options available for this executable format:
 
-  (none)
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
 
 
 
 =head2 NOTES FOR WATCOM/LE
 
-UPX has been successfully tested with the following extenders:
+B<UPX> has been successfully tested with the following extenders:
   DOS4G, DOS4GW, PMODE/W, DOS32a, CauseWay.
   The WDOS/X extender is partly supported (for details
   see the file bugs BUGS).
 
-Yes, you can use your compressed executables with DOS4GW.
-
-The LX format is not yet supported.
-
-DLLs are not supported.
+DLLs and the LX format are not supported.
 
 Extra options available for this executable format:
 
@@ -706,14 +811,15 @@ Extra options available for this executable format:
 
 =head2 NOTES FOR WIN32/PE
 
-The PE support in UPX is quite stable now, but probably there are
-still some incompabilities with some files.
+The PE support in B<UPX> is quite stable now, but probably there are
+still some incompatibilities with some files.
 
-Because of the way UPX (and other packers for this format) works, you
-can see increased memory usage of your compressed files. If you start
-several instances of huge compressed programs you're wasting memory
-because the common segements of the program won't get shared
-across the instances.
+Because of the way B<UPX> (and other packers for this format) works, you
+can see increased memory usage of your compressed files because the whole
+program is loaded into memory at startup.
+If you start several instances of huge compressed programs you're
+wasting memory because the common segments of the program won't
+get shared across the instances.
 On the other hand if you're compressing only smaller programs, or
 running only one instance of larger programs, then this penalty is
 smaller, but it's still there.
@@ -721,7 +827,18 @@ smaller, but it's still there.
 If you're running executables from network, then compressed programs
 will load faster, and require less bandwidth during execution.
 
-DLLs are supported.
+DLLs are supported. But UPX compressed DLLs can not share common data and
+code when they got used by multiple applications. So compressing msvcrt.dll
+is a waste of memory, but compressing the dll plugins of a particular
+application may be a better idea.
+
+Screensavers are supported, with the restriction that the filename
+must end with ".scr" (as screensavers are handled slightly different
+than normal exe files).
+
+UPX compressed PE files have some minor memory overhead (usually in the
+10 - 30 KiB range) which can be seen by specifying the "-i" command
+line switch during compression.
 
 Extra options available for this executable format:
 
@@ -739,9 +856,26 @@ Extra options available for this executable format:
   --compress-icons=1  Compress all but the first icon.
   --compress-icons=2  Compress all icons which are not in the
                       first icon directory. [DEFAULT]
+  --compress-icons=3  Compress all icons.
 
   --compress-resources=0  Don't compress any resources at all.
 
+  --keep-resource=list Don't compress resources specified by the list.
+                      The members of the list are separated by commas.
+                      A list member has the following format: I<type[/name]>.
+                      I<Type> is the type of the resource. Standard types
+                      must be specified as decimal numbers, user types can be
+                      specified by decimal IDs or strings. I<Name> is the
+                      identifier of the resource. It can be a decimal number
+                      or a string. For example:
+
+                      --keep-resource=2/MYBITMAP,5,6/12345
+
+                      UPX won't compress the named bitmap resource "MYBITMAP",
+                      it leaves every dialog (5) resource uncompressed, and
+                      it won't touch the string table resource with identifier
+                      12345.
+
   --force             Force compression even when there is an
                       unexpected value in a header field.
                       Use with care.
@@ -752,10 +886,20 @@ Extra options available for this executable format:
                       address greater or equal to 0x400000. Usually the
                       compressed files becomes smaller, but some files
                       may become larger. Note that the resulting file will
-                      not work under Win32s.
+                      not work under Windows 3.x (Win32s).
                       UPX never strips relocations from a DLL
                       regardless of this option.
 
+  --all-methods       Compress the program several times, using all
+                      available compression methods. This may improve
+                      the compression ratio in some cases, but usually
+                      the default method gives the best results anyway.
+
+  --all-filters       Compress the program several times, using all
+                      available preprocessing filters. This may improve
+                      the compression ratio in some cases, but usually
+                      the default filter gives the best results anyway.
+
 
 
 =head1 DIAGNOSTICS
@@ -775,31 +919,37 @@ Please report all bugs immediately to the authors.
 
 =head1 AUTHORS
 
- Markus F.X.J. Oberhumer <markus.oberhumer@jk.uni-linz.ac.at>
- http://wildsau.idv.uni-linz.ac.at/mfx/
+ Markus F.X.J. Oberhumer <markus@oberhumer.com>
+ http://www.oberhumer.com
 
- Laszlo Molnar <ml1050@cdata.tvnet.hu>
+ Laszlo Molnar <ezerotven+github@gmail.com>
 
  John F. Reiser <jreiser@BitWagon.com>
 
+ Jens Medoch <jssg@users.sourceforge.net>
+
 
 
 =head1 COPYRIGHT
 
-Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
+Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
 
-Copyright (C) 1996-2000 Laszlo Molnar
+Copyright (C) 1996-2023 Laszlo Molnar
 
-Copyright (C) 2000 John Reiser
+Copyright (C) 2000-2023 John F. Reiser
 
-This program may be used freely, and you are welcome to
-redistribute it under certain conditions.
+Copyright (C) 2002-2023 Jens Medoch
+
+B<UPX> is distributed with full source code under the terms of the
+GNU General Public License v2+; either under the pure GPLv2+ (see
+the file COPYING), or (at your option) under the GPLv+2 with special
+exceptions and restrictions granting the free usage for all binaries
+including commercial programs (see the file LICENSE).
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-UPX License Agreement for more details.
-
-You should have received a copy of the UPX License Agreement along
-with this program; see the file LICENSE. If not, visit the UPX home page.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
+You should have received a copy of the UPX License Agreements along
+with this program; see the files COPYING and LICENSE. If not,
+visit the UPX home page.

misc/analyze/clang-tidy/clang-tidy-bzip2.yml

@@ -0,0 +1,22 @@
+# for clang-tidy-16 from https://clang.llvm.org/extra/clang-tidy/
+---
+Checks: >
+  -*,
+  bugprone-*,
+    -bugprone-branch-clone,
+    -bugprone-easily-swappable-parameters,
+    -bugprone-implicit-widening-of-multiplication-result,
+    -bugprone-macro-parentheses,
+    -bugprone-narrowing-conversions,
+    -bugprone-reserved-identifier,
+    -bugprone-switch-missing-default-case,
+  clang-analyzer-*,
+    -clang-analyzer-core.UndefinedBinaryOperatorResult,
+    -clang-analyzer-core.uninitialized.Assign,
+    -clang-analyzer-security.insecureAPI.strcpy,
+  clang-diagnostics-*',
+  performance-*,
+FormatStyle: file
+HeaderFilterRegex: '.*'
+InheritParentConfig: false
+...

misc/analyze/clang-tidy/clang-tidy-ucl.yml

@@ -0,0 +1,20 @@
+# for clang-tidy-16 from https://clang.llvm.org/extra/clang-tidy/
+---
+Checks: >
+  -*,
+  bugprone-*,
+    -bugprone-assignment-in-if-condition,
+    -bugprone-easily-swappable-parameters,
+    -bugprone-implicit-widening-of-multiplication-result,
+    -bugprone-macro-parentheses,
+    -bugprone-reserved-identifier,
+    -bugprone-sizeof-expression,
+    -bugprone-suspicious-include,
+  clang-analyzer-*,
+    -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,
+  clang-diagnostics-*',
+  performance-*,
+FormatStyle: file
+HeaderFilterRegex: '.*'
+InheritParentConfig: false
+...

misc/analyze/clang-tidy/clang-tidy-zlib.yml

@@ -0,0 +1,21 @@
+# for clang-tidy-16 from https://clang.llvm.org/extra/clang-tidy/
+---
+Checks: >
+  -*,
+  bugprone-*,
+    -bugprone-assignment-in-if-condition,
+    -bugprone-easily-swappable-parameters,
+    -bugprone-implicit-widening-of-multiplication-result,
+    -bugprone-macro-parentheses,
+    -bugprone-narrowing-conversions,
+    -bugprone-reserved-identifier,
+    -bugprone-switch-missing-default-case,
+  clang-analyzer-*,
+    -clang-analyzer-optin.performance.Padding,
+    -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,
+  clang-diagnostics-*',
+  performance-*,
+FormatStyle: file
+HeaderFilterRegex: '.*'
+InheritParentConfig: false
+...

misc/analyze/clang-tidy/clang-tidy-zstd.yml

@@ -0,0 +1,25 @@
+# for clang-tidy-16 from https://clang.llvm.org/extra/clang-tidy/
+---
+Checks: >
+  -*,
+  bugprone-*,
+    -bugprone-assignment-in-if-condition,
+    -bugprone-branch-clone,
+    -bugprone-easily-swappable-parameters,
+    -bugprone-implicit-widening-of-multiplication-result,
+    -bugprone-macro-parentheses,
+    -bugprone-misplaced-widening-cast,
+    -bugprone-narrowing-conversions,
+    -bugprone-reserved-identifier,
+    -bugprone-switch-missing-default-case,
+  clang-analyzer-*,
+    -clang-analyzer-core.UndefinedBinaryOperatorResult,
+    -clang-analyzer-deadcode.DeadStores,
+    -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,
+  clang-diagnostics-*',
+  performance-*,
+    -performance-no-int-to-ptr,
+FormatStyle: file
+HeaderFilterRegex: '.*'
+InheritParentConfig: false
+...

misc/analyze/clang-tidy/run-clang-tidy.py

@@ -0,0 +1,515 @@
+#!/usr/bin/env python3
+#
+# ===- run-clang-tidy.py - Parallel clang-tidy runner --------*- python -*--===#
+#
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# ===-----------------------------------------------------------------------===#
+# FIXME: Integrate with clang-tidy-diff.py
+
+
+"""
+Parallel clang-tidy runner
+==========================
+
+Runs clang-tidy over all files in a compilation database. Requires clang-tidy
+and clang-apply-replacements in $PATH.
+
+Example invocations.
+- Run clang-tidy on all files in the current working directory with a default
+  set of checks and show warnings in the cpp files and all project headers.
+    run-clang-tidy.py $PWD
+
+- Fix all header guards.
+    run-clang-tidy.py -fix -checks=-*,llvm-header-guard
+
+- Fix all header guards included from clang-tidy and header guards
+  for clang-tidy headers.
+    run-clang-tidy.py -fix -checks=-*,llvm-header-guard extra/clang-tidy \
+                      -header-filter=extra/clang-tidy
+
+Compilation database setup:
+http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
+"""
+
+from __future__ import print_function
+
+import argparse
+import glob
+import json
+import multiprocessing
+import os
+import queue
+import re
+import shutil
+import subprocess
+import sys
+import tempfile
+import threading
+import traceback
+
+try:
+    import yaml
+except ImportError:
+    yaml = None
+
+
+def strtobool(val):
+    """Convert a string representation of truth to a bool following LLVM's CLI argument parsing."""
+
+    val = val.lower()
+    if val in ["", "true", "1"]:
+        return True
+    elif val in ["false", "0"]:
+        return False
+
+    # Return ArgumentTypeError so that argparse does not substitute its own error message
+    raise argparse.ArgumentTypeError(
+        "'{}' is invalid value for boolean argument! Try 0 or 1.".format(val)
+    )
+
+
+def find_compilation_database(path):
+    """Adjusts the directory until a compilation database is found."""
+    result = os.path.realpath("./")
+    while not os.path.isfile(os.path.join(result, path)):
+        parent = os.path.dirname(result)
+        if result == parent:
+            print("Error: could not find compilation database.")
+            sys.exit(1)
+        result = parent
+    return result
+
+
+def make_absolute(f, directory):
+    if os.path.isabs(f):
+        return f
+    return os.path.normpath(os.path.join(directory, f))
+
+
+def get_tidy_invocation(
+    f,
+    clang_tidy_binary,
+    checks,
+    tmpdir,
+    build_path,
+    header_filter,
+    allow_enabling_alpha_checkers,
+    extra_arg,
+    extra_arg_before,
+    quiet,
+    config_file_path,
+    config,
+    line_filter,
+    use_color,
+    plugins,
+    warnings_as_errors,
+):
+    """Gets a command line for clang-tidy."""
+    start = [clang_tidy_binary]
+    if allow_enabling_alpha_checkers:
+        start.append("-allow-enabling-analyzer-alpha-checkers")
+    if header_filter is not None:
+        start.append("-header-filter=" + header_filter)
+    if line_filter is not None:
+        start.append("-line-filter=" + line_filter)
+    if use_color is not None:
+        if use_color:
+            start.append("--use-color")
+        else:
+            start.append("--use-color=false")
+    if checks:
+        start.append("-checks=" + checks)
+    if tmpdir is not None:
+        start.append("-export-fixes")
+        # Get a temporary file. We immediately close the handle so clang-tidy can
+        # overwrite it.
+        (handle, name) = tempfile.mkstemp(suffix=".yaml", dir=tmpdir)
+        os.close(handle)
+        start.append(name)
+    for arg in extra_arg:
+        start.append("-extra-arg=%s" % arg)
+    for arg in extra_arg_before:
+        start.append("-extra-arg-before=%s" % arg)
+    start.append("-p=" + build_path)
+    if quiet:
+        start.append("-quiet")
+    if config_file_path:
+        start.append("--config-file=" + config_file_path)
+    elif config:
+        start.append("-config=" + config)
+    for plugin in plugins:
+        start.append("-load=" + plugin)
+    if warnings_as_errors:
+        start.append("--warnings-as-errors=" + warnings_as_errors)
+    start.append(f)
+    return start
+
+
+def merge_replacement_files(tmpdir, mergefile):
+    """Merge all replacement files in a directory into a single file"""
+    # The fixes suggested by clang-tidy >= 4.0.0 are given under
+    # the top level key 'Diagnostics' in the output yaml files
+    mergekey = "Diagnostics"
+    merged = []
+    for replacefile in glob.iglob(os.path.join(tmpdir, "*.yaml")):
+        content = yaml.safe_load(open(replacefile, "r"))
+        if not content:
+            continue  # Skip empty files.
+        merged.extend(content.get(mergekey, []))
+
+    if merged:
+        # MainSourceFile: The key is required by the definition inside
+        # include/clang/Tooling/ReplacementsYaml.h, but the value
+        # is actually never used inside clang-apply-replacements,
+        # so we set it to '' here.
+        output = {"MainSourceFile": "", mergekey: merged}
+        with open(mergefile, "w") as out:
+            yaml.safe_dump(output, out)
+    else:
+        # Empty the file:
+        open(mergefile, "w").close()
+
+
+def find_binary(arg, name, build_path):
+    """Get the path for a binary or exit"""
+    if arg:
+        if shutil.which(arg):
+            return arg
+        else:
+            raise SystemExit(
+                "error: passed binary '{}' was not found or is not executable".format(
+                    arg
+                )
+            )
+
+    built_path = os.path.join(build_path, "bin", name)
+    binary = shutil.which(name) or shutil.which(built_path)
+    if binary:
+        return binary
+    else:
+        raise SystemExit(
+            "error: failed to find {} in $PATH or at {}".format(name, built_path)
+        )
+
+
+def apply_fixes(args, clang_apply_replacements_binary, tmpdir):
+    """Calls clang-apply-fixes on a given directory."""
+    invocation = [clang_apply_replacements_binary]
+    invocation.append("-ignore-insert-conflict")
+    if args.format:
+        invocation.append("-format")
+    if args.style:
+        invocation.append("-style=" + args.style)
+    invocation.append(tmpdir)
+    subprocess.call(invocation)
+
+
+def run_tidy(args, clang_tidy_binary, tmpdir, build_path, queue, lock, failed_files):
+    """Takes filenames out of queue and runs clang-tidy on them."""
+    while True:
+        name = queue.get()
+        invocation = get_tidy_invocation(
+            name,
+            clang_tidy_binary,
+            args.checks,
+            tmpdir,
+            build_path,
+            args.header_filter,
+            args.allow_enabling_alpha_checkers,
+            args.extra_arg,
+            args.extra_arg_before,
+            args.quiet,
+            args.config_file,
+            args.config,
+            args.line_filter,
+            args.use_color,
+            args.plugins,
+            args.warnings_as_errors,
+        )
+
+        proc = subprocess.Popen(
+            invocation, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+        )
+        output, err = proc.communicate()
+        if proc.returncode != 0:
+            if proc.returncode < 0:
+                msg = "%s: terminated by signal %d\n" % (name, -proc.returncode)
+                err += msg.encode("utf-8")
+            failed_files.append(name)
+        with lock:
+            sys.stdout.write(" ".join(invocation) + "\n" + output.decode("utf-8"))
+            if len(err) > 0:
+                sys.stdout.flush()
+                sys.stderr.write(err.decode("utf-8"))
+        queue.task_done()
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Runs clang-tidy over all files "
+        "in a compilation database. Requires "
+        "clang-tidy and clang-apply-replacements in "
+        "$PATH or in your build directory."
+    )
+    parser.add_argument(
+        "-allow-enabling-alpha-checkers",
+        action="store_true",
+        help="allow alpha checkers from " "clang-analyzer.",
+    )
+    parser.add_argument(
+        "-clang-tidy-binary", metavar="PATH", help="path to clang-tidy binary"
+    )
+    parser.add_argument(
+        "-clang-apply-replacements-binary",
+        metavar="PATH",
+        help="path to clang-apply-replacements binary",
+    )
+    parser.add_argument(
+        "-checks",
+        default=None,
+        help="checks filter, when not specified, use clang-tidy " "default",
+    )
+    config_group = parser.add_mutually_exclusive_group()
+    config_group.add_argument(
+        "-config",
+        default=None,
+        help="Specifies a configuration in YAML/JSON format: "
+        "  -config=\"{Checks: '*', "
+        '                       CheckOptions: {x: y}}" '
+        "When the value is empty, clang-tidy will "
+        "attempt to find a file named .clang-tidy for "
+        "each source file in its parent directories.",
+    )
+    config_group.add_argument(
+        "-config-file",
+        default=None,
+        help="Specify the path of .clang-tidy or custom config "
+        "file: e.g. -config-file=/some/path/myTidyConfigFile. "
+        "This option internally works exactly the same way as "
+        "-config option after reading specified config file. "
+        "Use either -config-file or -config, not both.",
+    )
+    parser.add_argument(
+        "-header-filter",
+        default=None,
+        help="regular expression matching the names of the "
+        "headers to output diagnostics from. Diagnostics from "
+        "the main file of each translation unit are always "
+        "displayed.",
+    )
+    parser.add_argument(
+        "-line-filter",
+        default=None,
+        help="List of files with line ranges to filter the" "warnings.",
+    )
+    if yaml:
+        parser.add_argument(
+            "-export-fixes",
+            metavar="filename",
+            dest="export_fixes",
+            help="Create a yaml file to store suggested fixes in, "
+            "which can be applied with clang-apply-replacements.",
+        )
+    parser.add_argument(
+        "-j",
+        type=int,
+        default=0,
+        help="number of tidy instances to be run in parallel.",
+    )
+    parser.add_argument(
+        "files", nargs="*", default=[".*"], help="files to be processed (regex on path)"
+    )
+    parser.add_argument("-fix", action="store_true", help="apply fix-its")
+    parser.add_argument(
+        "-format", action="store_true", help="Reformat code " "after applying fixes"
+    )
+    parser.add_argument(
+        "-style",
+        default="file",
+        help="The style of reformat " "code after applying fixes",
+    )
+    parser.add_argument(
+        "-use-color",
+        type=strtobool,
+        nargs="?",
+        const=True,
+        help="Use colors in diagnostics, overriding clang-tidy's"
+        " default behavior. This option overrides the 'UseColor"
+        "' option in .clang-tidy file, if any.",
+    )
+    parser.add_argument(
+        "-p", dest="build_path", help="Path used to read a compile command database."
+    )
+    parser.add_argument(
+        "-extra-arg",
+        dest="extra_arg",
+        action="append",
+        default=[],
+        help="Additional argument to append to the compiler " "command line.",
+    )
+    parser.add_argument(
+        "-extra-arg-before",
+        dest="extra_arg_before",
+        action="append",
+        default=[],
+        help="Additional argument to prepend to the compiler " "command line.",
+    )
+    parser.add_argument(
+        "-quiet", action="store_true", help="Run clang-tidy in quiet mode"
+    )
+    parser.add_argument(
+        "-load",
+        dest="plugins",
+        action="append",
+        default=[],
+        help="Load the specified plugin in clang-tidy.",
+    )
+    parser.add_argument(
+        "-warnings-as-errors",
+        default=None,
+        help="Upgrades warnings to errors. Same format as " "'-checks'",
+    )
+    args = parser.parse_args()
+
+    db_path = "compile_commands.json"
+
+    if args.build_path is not None:
+        build_path = args.build_path
+    else:
+        # Find our database
+        build_path = find_compilation_database(db_path)
+
+    clang_tidy_binary = find_binary(args.clang_tidy_binary, "clang-tidy", build_path)
+
+    tmpdir = None
+    if args.fix:
+        clang_apply_replacements_binary = find_binary(
+            args.clang_apply_replacements_binary, "clang-apply-replacements", build_path
+        )
+        tmpdir = tempfile.mkdtemp()
+
+    # Load the database and extract all files.
+    database = json.load(open(os.path.join(build_path, db_path)))
+    files = set(
+        [make_absolute(entry["file"], entry["directory"]) for entry in database]
+    )
+
+    # Build up a big regexy filter from all command line arguments.
+    file_name_re = re.compile("|".join(args.files))
+
+    # filter files with mo.group(0), and sort files
+    matched_files = []
+    for name in files:
+        mo = file_name_re.search(name)
+        if mo and mo.group(0):
+            matched_files.append(name)
+    files = sorted(matched_files)
+    if not files:
+        if tmpdir:
+            shutil.rmtree(tmpdir)
+        sys.exit(0)
+
+    try:
+        invocation = get_tidy_invocation(
+            "",
+            clang_tidy_binary,
+            args.checks,
+            None,
+            build_path,
+            args.header_filter,
+            args.allow_enabling_alpha_checkers,
+            args.extra_arg,
+            args.extra_arg_before,
+            args.quiet,
+            args.config_file,
+            args.config,
+            args.line_filter,
+            args.use_color,
+            args.plugins,
+            args.warnings_as_errors,
+        )
+        invocation.append("-list-checks")
+        invocation.append("-")
+        if args.quiet:
+            # Even with -quiet we still want to check if we can call clang-tidy.
+            with open(os.devnull, "w") as dev_null:
+                subprocess.check_call(invocation, stdout=dev_null)
+        else:
+            subprocess.check_call(invocation)
+    except:
+        print("Unable to run clang-tidy.", file=sys.stderr)
+        sys.exit(1)
+
+    max_task = args.j
+    if max_task == 0:
+        max_task = multiprocessing.cpu_count()
+
+    return_code = 0
+    try:
+        # Spin up a bunch of tidy-launching threads.
+        task_queue = queue.Queue(max_task)
+        # List of files with a non-zero return code.
+        failed_files = []
+        lock = threading.Lock()
+        for _ in range(max_task):
+            t = threading.Thread(
+                target=run_tidy,
+                args=(
+                    args,
+                    clang_tidy_binary,
+                    tmpdir,
+                    build_path,
+                    task_queue,
+                    lock,
+                    failed_files,
+                ),
+            )
+            t.daemon = True
+            t.start()
+
+        # Fill the queue with files.
+        for name in files:
+            if file_name_re.search(name):
+                task_queue.put(name)
+
+        # Wait for all threads to be done.
+        task_queue.join()
+        if len(failed_files):
+            return_code = 1
+
+    except KeyboardInterrupt:
+        # This is a sad hack. Unfortunately subprocess goes
+        # bonkers with ctrl-c and we start forking merrily.
+        print("\nCtrl-C detected, goodbye.")
+        if tmpdir:
+            shutil.rmtree(tmpdir)
+        os.kill(0, 9)
+
+    if yaml and args.export_fixes:
+        print("Writing fixes to " + args.export_fixes + " ...")
+        try:
+            merge_replacement_files(tmpdir, args.export_fixes)
+        except:
+            print("Error exporting fixes.\n", file=sys.stderr)
+            traceback.print_exc()
+            return_code = 1
+
+    if args.fix:
+        print("Applying fixes ...")
+        try:
+            apply_fixes(args, clang_apply_replacements_binary, tmpdir)
+        except:
+            print("Error applying fixes.\n", file=sys.stderr)
+            traceback.print_exc()
+            return_code = 1
+
+    if tmpdir:
+        shutil.rmtree(tmpdir)
+    sys.exit(return_code)
+
+
+if __name__ == "__main__":
+    main()

misc/podman/cross-compile-upx-ubuntu/10-create-image.sh

@@ -0,0 +1,19 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# create the image from Dockerfile
+# using a rootless Podman container
+
+# NOTE: this image is based on rebuild-stubs/upx-stubtools-20221212-v6,
+#   so you have to create that image first
+# WARNING: we install many packages, so the resulting image needs A LOT of disk space!
+image=upx-cross-compile-ubuntu2204-20230721-v1
+[[ $1 == --print-image ]] && echo "$image" && exit 0
+
+podman build -t "$image" -f "$argv0dir/Dockerfile" "$argv0dir"
+
+podman image list "$image"
+echo
+podman image tree "$image"

misc/podman/cross-compile-upx-ubuntu/11-list-packages.sh

@@ -0,0 +1,40 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# list all system packages that are installed in the image
+# using a rootless Podman container
+
+image="$("$argv0dir/10-create-image.sh" --print-image)"
+
+podman image list "$image"
+echo
+podman image tree "$image"
+
+echo 'Packages:'
+flags=( --read-only --rm --pull=never )
+flags+=( --cap-drop=all )               # drop all capabilities
+flags+=( --network=none )               # no network needed
+podman run "${flags[@]}" "$image" bash -c $'dpkg -l | sed \'s/ *$//\' | LC_ALL=C sort'
+
+echo
+echo 'Packages sorted by Installed-Size:'
+podman run "${flags[@]}" "$image" bash -c $'awk \'
+BEGIN {
+    arch = "UNKNOWN"; size = 0; package = "UNKNOWN";
+}
+{
+    if ($1 == "Architecture:") arch = $2;
+    if ($1 == "Installed-Size:") size = $2;
+    if ($1 == "Package:") package = $2;
+    if ($1 == "") {
+        printf("%9d %-40s %s\\n", size, package, arch);
+        count += 1; total += size;
+        arch = "UNKNOWN"; size = 0; package = "UNKNOWN";
+    }
+}
+END {
+    printf("%9d ===== TOTAL (%d packages)\\n", total, count);
+}
+\' /var/lib/dpkg/status | LC_ALL=C sort -rn'

misc/podman/cross-compile-upx-ubuntu/20-image-run-shell.sh

@@ -0,0 +1,60 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# run an interactive shell in the image
+# using a rootless Podman container
+
+image="$("$argv0dir/10-create-image.sh" --print-image)"
+
+flags=( --read-only --rm --pull=never )
+flags+=( --cap-drop=all )               # drop all capabilities
+flags+=( --network=none )               # no network needed
+flags+=( -ti -e TERM="$TERM" )          # allocate an interactive pseudo-tty and pass $TERM
+if [[ 1 == 1 ]]; then
+    # run as user upx 2000:2000
+    flags+=( --user 2000 )
+    # map container users 0..999 to subuid-users 1..1000, and map container user 2000 to current host user
+    flags+=( --uidmap=0:1:1000 --uidmap=2000:0:1 )
+    # map container groups 0..999 to subgid-groups 1..1000, and map container group 2000 to current host group
+    flags+=( --gidmap=0:1:1000 --gidmap=2000:0:1 )
+    # NOTE: we mount the upx top-level directory read-write under /home/upx/src/upx
+    # INFO: SELinux users *may* have to add ":z" to the volume mount flags; check the docs!
+    flags+=( -v "${argv0dir}/../../..:/home/upx/src/upx" )
+    flags+=( -w /home/upx/src/upx )     # set working directory
+    flags+=( --tmpfs /home/upx/.cache:rw,exec ) # mount a writeable tmpfs
+    flags+=( --tmpfs /home/upx/.local:rw,exec ) # mount a writeable tmpfs
+else
+    # run as user root 0:0
+    # ONLY FOR DEBUGGING THE IMAGE
+    # map container user/group 0 to current host user/group
+    flags+=( --user 0 )
+fi
+
+if [[ $# == 0 ]]; then
+    podman run "${flags[@]}" "$image" bash -l
+else
+    podman run "${flags[@]}" "$image" "$@"
+fi
+
+# now we can cross-compile UPX for Windows:
+#   cd /home/upx/src/upx
+#   rm -rf ./build/extra/cross-windows-mingw64/release
+#   make build/extra/cross-windows-mingw64/release
+
+# and we can run the clang Static Analyzer (scan-build)
+#   cd /home/upx/src/upx
+#   rm -rf ./build/extra/scan-build/release
+#   make build/extra/scan-build/release
+
+# and lots of other cross-compilers are installed; see "ls /usr/bin/*g++*"
+
+# and finally see
+#   ./misc/podman/cross-compile-upx-ubuntu/build-all-inside-container.sh
+# after running that script we can do cool things like:
+#   cd /home/upx/src/upx/build/cross-compile-upx-ubuntu2204/alpha-linux-gnu/debug
+#   qemu-alpha -L /usr/alpha-linux-gnu ./upx --version
+#   cd /home/upx/src/upx/build/cross-compile-upx-ubuntu2204/hppa-linux-gnu/debug
+#   qemu-hppa -L /usr/hppa-linux-gnu ./upx --version
+# (similar for many other architectures/builds)

misc/podman/cross-compile-upx-ubuntu/Dockerfile

@@ -0,0 +1,54 @@
+# NOTE: this image is based on rebuild-stubs/upx-stubtools-20221212-v6,
+#   so you have to create that image first
+# WARNING: we install many packages, so the resulting image needs A LOT of disk space!
+FROM localhost/upx-stubtools-20221212-v6
+ENV UPX_CONTAINER_IMAGE_NAME=upx-cross-compile-ubuntu2204-20230721-v1
+ARG DEBIAN_FRONTEND=noninteractive
+
+USER root
+
+# Ubuntu 22.04
+RUN apt-get update && apt-get upgrade -y \
+    && apt-get install -y \
+        # Linux glibc cross compilers
+        g++-aarch64-linux-gnu \
+        g++-alpha-linux-gnu \
+        g++-arm-linux-gnueabi \
+        g++-arm-linux-gnueabihf \
+        g++-hppa-linux-gnu \
+        g++-i686-linux-gnu \
+        g++-m68k-linux-gnu \
+        g++-mips-linux-gnu \
+        g++-mipsel-linux-gnu \
+        g++-mips64-linux-gnuabi64 \
+        g++-mips64el-linux-gnuabi64 \
+        g++-powerpc-linux-gnu \
+        g++-powerpc64-linux-gnu \
+        g++-powerpc64le-linux-gnu \
+        g++-riscv64-linux-gnu \
+        g++-s390x-linux-gnu \
+        g++-sh4-linux-gnu \
+        g++-sparc64-linux-gnu \
+        # Linux glibc cross compilers - ILP32 on 64-bit CPUs
+        g++-x86-64-linux-gnux32 \
+        # Windows cross compilers
+        g++-mingw-w64-i686 \
+        g++-mingw-w64-x86-64 \
+    && true
+RUN apt-get install -y \
+        # clang-14 and tools
+        clang-14 clang-format-14 clang-tidy-14 clang-tools-14 lldb-14 llvm-14 \
+        # QEMU and Wine
+        qemu-system qemu-user wine wine32:i386 wine64 \
+        # misc
+        gdb lsb-release valgrind \
+    && true
+RUN cd /usr/bin \
+    # create unversioned clang symlinks in /usr/local/bin
+    && for f in clang*-14 llvm-*-14 scan-*-14; do ln -s -v ../../bin/$f /usr/local/bin/${f%-14}; done \
+    && ln -s -v ../../bin/obj2yaml-14 /usr/local/bin/llvm-obj2yaml \
+    && ln -s -v ../../bin/yaml2obj-14 /usr/local/bin/llvm-yaml2obj \
+    && true
+
+# switch back to default user upx:upx 2000:2000
+USER upx

misc/podman/cross-compile-upx-ubuntu/build-all-inside-container.sh

@@ -0,0 +1,99 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# build UPX for 21 targets; must be run inside the container!
+# using a rootless Podman container
+
+# simple sanity check that we are indeed running inside the container
+if [[ $UPX_CONTAINER_IMAGE_NAME != upx-cross-compile-* ]]; then
+    echo "$argv0: NOTE: please run this script *inside* the container"
+    exit 1
+fi
+
+# go to upx top-level directory
+cd "$argv0dir/../../.." || exit 1
+pwd
+test -f doc/upx.pod   || exit 1 # sanity check
+test -f src/version.h || exit 1 # sanity check
+
+function run_config_and_build {
+    # requires: AR CC CXX RANLIB
+    local toolchain=$1
+    local cmake_config_flags build_type bdir
+    # cmake flags
+    cmake_config_flags=
+    case $toolchain in
+        # these old architectures do not support sanitize
+        alpha-linux-gnu) cmake_config_flags=-DUPX_CONFIG_DISABLE_SANITIZE=ON ;;
+        hppa-linux-gnu) cmake_config_flags=-DUPX_CONFIG_DISABLE_SANITIZE=ON ;;
+        # avoid sanitize link errors with current MinGW-w64 versions; link libstdc++ statically
+        i686-w64-mingw32)
+            cmake_config_flags=-DUPX_CONFIG_DISABLE_SANITIZE=ON
+            CC="$CC -static"; CXX="$CXX -static" ;;
+        x86_64-w64-mingw32)
+            cmake_config_flags=-DUPX_CONFIG_DISABLE_SANITIZE=ON
+            CC="$CC -static"; CXX="$CXX -static" ;;
+        # avoid warnings about arm libstdc++ ABI change in gcc-7
+        arm-linux-*) CXX="$CXX -Wno-psabi" ;;
+    esac
+    if [[ 1 == 1 ]]; then
+        # prefer building with Ninja (ninja-build)
+        cmake_config_flags="$cmake_config_flags -G Ninja -DUPX_CONFIG_CMAKE_DISABLE_INSTALL=ON"
+    fi
+    # for all build types
+    for build_type in Debug Release; do
+        bdir="build/cross-compile-upx-ubuntu2204/$toolchain/${build_type,,}"
+        mkdir -p "$bdir"
+        # run_config
+        if [[ ! -f $bdir/CMakeCache.txt ]]; then
+            export CMAKE_REQUIRED_QUIET=OFF
+            cmake -S . -B "$bdir" -DCMAKE_BUILD_TYPE=$build_type -DCMAKE_AR=$AR -DCMAKE_RANLIB=$RANLIB $cmake_config_flags
+        fi
+        # run_build
+        cmake --build "$bdir" --config $build_type --parallel
+    done
+}
+
+# see Dockerfile for packages
+for package in \
+        g++-aarch64-linux-gnu \
+        g++-alpha-linux-gnu \
+        g++-arm-linux-gnueabi \
+        g++-arm-linux-gnueabihf \
+        g++-hppa-linux-gnu \
+        g++-i686-linux-gnu \
+        g++-m68k-linux-gnu \
+        g++-mips-linux-gnu \
+        g++-mipsel-linux-gnu \
+        g++-mips64-linux-gnuabi64 \
+        g++-mips64el-linux-gnuabi64 \
+        g++-powerpc-linux-gnu \
+        g++-powerpc64-linux-gnu \
+        g++-powerpc64le-linux-gnu \
+        g++-riscv64-linux-gnu \
+        g++-s390x-linux-gnu \
+        g++-sh4-linux-gnu \
+        g++-sparc64-linux-gnu \
+        g++-x86-64-linux-gnux32 \
+        g++-mingw-w64-i686 \
+        g++-mingw-w64-x86-64
+do
+    # setup toolchain and environment variables
+    toolchain=$package
+    toolchain=${toolchain/-x86-64/-x86_64}
+    toolchain=${toolchain/g++-/}
+    case $toolchain in
+        mingw-w64-i686) toolchain=i686-w64-mingw32 ;;
+        mingw-w64-x86_64) toolchain=x86_64-w64-mingw32 ;;
+    esac
+    echo "========== $toolchain"
+    export AR=/usr/bin/${toolchain}-ar
+    export CC=/usr/bin/${toolchain}-gcc
+    export CXX=/usr/bin/${toolchain}-g++
+    export RANLIB=/usr/bin/${toolchain}-ranlib
+    ls -l $AR $CC $CXX $RANLIB
+    run_config_and_build $toolchain
+    unset AR CC CXX RANLIB
+done

misc/podman/rebuild-stubs/10-create-image.sh

@@ -0,0 +1,16 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# create the image from Dockerfile
+# using a rootless Podman container
+
+image=upx-stubtools-20221212-v6
+[[ $1 == --print-image ]] && echo "$image" && exit 0
+
+podman build -t "$image" -f "$argv0dir/Dockerfile" "$argv0dir"
+
+podman image list "$image"
+echo
+podman image tree "$image"

misc/podman/rebuild-stubs/11-list-packages.sh

@@ -0,0 +1,40 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# list all system packages that are installed in the image
+# using a rootless Podman container
+
+image="$("$argv0dir/10-create-image.sh" --print-image)"
+
+podman image list "$image"
+echo
+podman image tree "$image"
+
+echo 'Packages:'
+flags=( --read-only --rm --pull=never )
+flags+=( --cap-drop=all )               # drop all capabilities
+flags+=( --network=none )               # no network needed
+podman run "${flags[@]}" "$image" bash -c $'dpkg -l | sed \'s/ *$//\' | LC_ALL=C sort'
+
+echo
+echo 'Packages sorted by Installed-Size:'
+podman run "${flags[@]}" "$image" bash -c $'awk \'
+BEGIN {
+    arch = "UNKNOWN"; size = 0; package = "UNKNOWN";
+}
+{
+    if ($1 == "Architecture:") arch = $2;
+    if ($1 == "Installed-Size:") size = $2;
+    if ($1 == "Package:") package = $2;
+    if ($1 == "") {
+        printf("%9d %-40s %s\\n", size, package, arch);
+        count += 1; total += size;
+        arch = "UNKNOWN"; size = 0; package = "UNKNOWN";
+    }
+}
+END {
+    printf("%9d ===== TOTAL (%d packages)\\n", total, count);
+}
+\' /var/lib/dpkg/status | LC_ALL=C sort -rn'

misc/podman/rebuild-stubs/20-image-run-shell.sh

@@ -0,0 +1,82 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs="$(readlink -fn "$argv0")"; argv0dir="$(dirname "$argv0abs")"
+
+# run an interactive shell in the image
+# using a rootless Podman container
+
+image="$("$argv0dir/10-create-image.sh" --print-image)"
+
+flags=( --read-only --rm --pull=never )
+flags+=( --cap-drop=all )               # drop all capabilities
+flags+=( --network=none )               # no network needed
+flags+=( -ti -e TERM="$TERM" )          # allocate an interactive pseudo-tty and pass $TERM
+if [[ 1 == 1 ]]; then
+    # run as user upx 2000:2000
+    flags+=( --user 2000 )
+    # map container users 0..999 to subuid-users 1..1000, and map container user 2000 to current host user
+    flags+=( --uidmap=0:1:1000 --uidmap=2000:0:1 )
+    # map container groups 0..999 to subgid-groups 1..1000, and map container group 2000 to current host group
+    flags+=( --gidmap=0:1:1000 --gidmap=2000:0:1 )
+    # NOTE: we mount the upx top-level directory read-write under /home/upx/src/upx
+    # INFO: SELinux users *may* have to add ":z" to the volume mount flags; check the docs!
+    flags+=( -v "${argv0dir}/../../..:/home/upx/src/upx" )
+    flags+=( -w /home/upx/src/upx )     # set working directory
+    flags+=( --tmpfs /home/upx/.cache:rw,exec ) # mount a writeable tmpfs
+    flags+=( --tmpfs /home/upx/.local:rw,exec ) # mount a writeable tmpfs
+else
+    # run as user root 0:0
+    # ONLY FOR DEBUGGING THE IMAGE
+    # map container user/group 0 to current host user/group
+    flags+=( --user 0 )
+fi
+
+if [[ $# == 0 ]]; then
+    podman run "${flags[@]}" "$image" bash -l
+else
+    podman run "${flags[@]}" "$image" "$@"
+fi
+
+# now we can rebuild the UPX stubs:
+#   cd /home/upx/src/upx/src/stub
+#   # make sure that git is clean:
+#   git status .
+#   # remove stub files and make sure that they got deleted:
+#   make maintainer-clean extra-clean
+#   git status .
+#   # rebuild
+#   make extra-all all
+#   # make sure that the stub files did rebuild correctly:
+#   git status .
+#   git diff .
+
+# we can also build UPX in the container:
+#   cd /home/upx/src/upx
+#   rm -rf ./build/extra/gcc/release
+#   make build/extra/gcc/release
+#   # run tests
+#   ./build/extra/gcc/release/upx --version
+#   make -C build/extra/gcc/release test
+
+# and we can also build UPX with -m32:
+#   cd /home/upx/src/upx
+#   rm -rf ./build/extra/gcc-m32/release
+#   make build/extra/gcc-m32/release
+#   # run tests
+#   ./build/extra/gcc-m32/release/upx --version
+#   make -C build/extra/gcc-m32/release test
+
+# and we can also build UPX with -mx32: (NOTE: needs CONFIG_X86_X32_ABI on host kernel!)
+#   cd /home/upx/src/upx
+#   rm -rf ./build/extra/gcc-mx32/release
+#   make build/extra/gcc-mx32/release
+#   # run tests (needs CONFIG_X86_X32_ABI on host kernel)
+#   ./build/extra/gcc-mx32/release/upx --version
+#   make -C build/extra/gcc-mx32/release test
+
+# and we can also rebuild the UPX docs the container:
+#   cd /home/upx/src/upx/doc
+#   make clean all
+#   git status .
+#   git diff .

misc/podman/rebuild-stubs/Dockerfile

@@ -0,0 +1,64 @@
+FROM docker.io/library/ubuntu:22.04
+ENV UPX_CONTAINER_IMAGE_NAME=upx-stubtools-20221212-v6
+ARG DEBIAN_FRONTEND=noninteractive
+ENV LANG=C.UTF-8
+
+# install system packages
+RUN dpkg --add-architecture i386 \
+    && apt-get update && apt-get upgrade -y \
+    && apt-get install -y --no-install-recommends \
+        aria2 bash bash-completion ca-certificates dash git less libmpc3 libncurses5 \
+        make ncurses-term perl-base python2-minimal time wget xz-utils \
+        libc6:i386 zlib1g:i386 \
+        # the following packages are not required for rebuilding the stubs, but
+        # they do make the image *much* more convenient and also allow building
+        # the full UPX binary inside the container via CMake:
+        7zip bfs busybox bzip2 cabextract ccache chrpath cmake cpio curl elfutils fd-find file fzf \
+        g++ gawk gdb gojq ht htop hyperfine jq libzstd-dev lsb-release lz4 lzip lzop \
+        mksh moreutils ninja-build p7zip parallel patch patchelf pax-utils paxctl \
+        re2c ripgrep rsync screen universal-ctags unzip vim yash zip zlib1g-dev zsh zstd \
+        # extra packages for compiling with "gcc -m32" and and "gcc -mx32":
+        g++-multilib gcc-multilib \
+    && true
+
+# manually unpack and install compat libs from Ubuntu-16.04; REQUIRED
+RUN cd /root \
+    && aria2c --checksum=sha-256=de22baf3dd851a10e16fbf66a243e70149ca46e06b2939fdc79429196cefc090 \
+              'https://archive.kernel.org/ubuntu-archive/ubuntu/pool/main/m/mpfr4/libmpfr4_3.1.6-1_amd64.deb' \
+    && mkdir packages \
+    && for f in ./*.deb; do dpkg -x $f ./packages; done \
+    && mv -v -n ./packages/usr/lib/x86_64-linux-gnu/lib* /usr/lib/x86_64-linux-gnu/ \
+    && rm -rf ./*.deb ./packages \
+    && ldconfig \
+    && true
+
+# install upx-stubtools into /usr/local/bin/bin-upx-20221212; REQUIRED
+RUN cd /root \
+    && aria2c --checksum=sha-256=509e06639118a79d8e79489a400e134c6d3ca36bad2c6ec29648d7c1e5b81afa \
+              'https://github.com/upx/upx-stubtools/releases/download/v20221212/bin-upx-20221212.tar.xz' \
+    && cd /usr/local/bin \
+    && tar -xoaf /root/bin-upx-20221212.tar.xz \
+    && rm /root/bin-upx-20221212.tar.xz \
+    && true
+
+# install official UPX release binaries into /usr/local/bin; not required but convenient for testing
+RUN cd /root \
+    && wget -q https://github.com/upx/upx/releases/download/v3.91/upx-3.91-amd64_linux.tar.bz2 \
+    && for v in 3.92 3.93 3.94 3.95 3.96 4.0.0 4.0.1 4.0.2 4.1.0; do wget -q https://github.com/upx/upx/releases/download/v${v}/upx-${v}-amd64_linux.tar.xz; done \
+    && for f in ./upx-*.tar.*; do tar -xoaf $f; done \
+    && for v in 3.91 3.92 3.93 3.94 3.95 3.96 4.0.0 4.0.1 4.0.2 4.1.0; do d=upx-${v}-amd64_linux; ./$d/upx -qq -d $d/upx -o /usr/local/bin/upx-${v}; done \
+    && rm -r ./upx-*.tar.* ./upx-*linux \
+    && true
+
+# create default user upx:upx 2000:2000
+RUN useradd upx -U --uid 2000 --shell /bin/bash -m \
+    && cd /home/upx && chmod 00700 . \
+    # prepare ~/.cache and ~/.local for possible tmpfs mounts
+    && mkdir -p .cache/tmp .local/bin src/upx \
+    && for d in ccache fontconfig go-build mesa_shader_cache tmp wine zig; do mkdir -p .cache/$d; done \
+    && for d in bin include lib share state; do mkdir -p .local/$d; done \
+    && ln -s .cache/wine .wine && ln -s .cache/tmp tmp \
+    && ln -s /usr/local/bin/bin-upx-20221212 .local/bin/bin-upx \
+    && chown -R upx:upx . \
+    && true
+USER upx

misc/podman/rebuild-stubs/packages.txt

@@ -0,0 +1,651 @@
+Packages:
++++-===========================-=======================================-============-================================================================================
+Desired=Unknown/Install/Remove/Purge/Hold
+ii  7zip                        21.07+dfsg-4                            amd64        7-Zip file archiver with a high compression ratio
+ii  adduser                     3.118ubuntu5                            all          add and remove users and groups
+ii  apt                         2.4.9                                   amd64        commandline package manager
+ii  aria2                       1.36.0-1                                amd64        High speed download utility
+ii  base-files                  12ubuntu4.3                             amd64        Debian base system miscellaneous files
+ii  base-passwd                 3.5.52build1                            amd64        Debian base system master password and group files
+ii  bash                        5.1-6ubuntu1                            amd64        GNU Bourne Again SHell
+ii  bash-completion             1:2.11-5ubuntu1                         all          programmable completion for the bash shell
+ii  bfs                         2.3.1-1                                 amd64        Breadth-first version of find(1)
+ii  binutils                    2.38-4ubuntu2.2                         amd64        GNU assembler, linker and binary utilities
+ii  binutils-common:amd64       2.38-4ubuntu2.2                         amd64        Common files for the GNU assembler, linker and binary utilities
+ii  binutils-x86-64-linux-gnu   2.38-4ubuntu2.2                         amd64        GNU binary utilities, for x86-64-linux-gnu target
+ii  bsdutils                    1:2.37.2-4ubuntu3                       amd64        basic utilities from 4.4BSD-Lite
+ii  busybox                     1:1.30.1-7ubuntu3                       amd64        Tiny utilities for small and embedded systems
+ii  bzip2                       1.0.8-5build1                           amd64        high-quality block-sorting file compressor - utilities
+ii  ca-certificates             20230311ubuntu0.22.04.1                 all          Common CA certificates
+ii  cabextract                  1.9-3                                   amd64        Microsoft Cabinet file unpacker
+ii  ccache                      4.5.1-1                                 amd64        Compiler cache for fast recompilation of C/C++ code
+ii  chrpath                     0.16-2                                  amd64        Tool to edit the rpath in ELF binaries
+ii  cmake                       3.22.1-1ubuntu1.22.04.1                 amd64        cross-platform, open-source make system
+ii  cmake-data                  3.22.1-1ubuntu1.22.04.1                 all          CMake data files (modules, templates and documentation)
+ii  coreutils                   8.32-4.1ubuntu1                         amd64        GNU core utilities
+ii  cpio                        2.13+dfsg-7                             amd64        GNU cpio -- a program to manage archives of files
+ii  cpp                         4:11.2.0-1ubuntu1                       amd64        GNU C preprocessor (cpp)
+ii  cpp-11                      11.3.0-1ubuntu1~22.04.1                 amd64        GNU C preprocessor
+ii  curl                        7.81.0-1ubuntu1.13                      amd64        command line tool for transferring data with URL syntax
+ii  dash                        0.5.11+git20210903+057cd650a4ed-3build1 amd64        POSIX-compliant shell
+ii  debconf                     1.5.79ubuntu1                           all          Debian configuration management system
+ii  debianutils                 5.5-1ubuntu2                            amd64        Miscellaneous utilities specific to Debian
+ii  dh-elpa-helper              2.0.9ubuntu1                            all          helper package for emacs lisp extensions
+ii  diffutils                   1:3.8-0ubuntu2                          amd64        File comparison utilities
+ii  distro-info-data            0.52ubuntu0.4                           all          information about the distributions' releases (data files)
+ii  dpkg                        1.21.1ubuntu2.2                         amd64        Debian package management system
+ii  e2fsprogs                   1.46.5-2ubuntu1.1                       amd64        ext2/ext3/ext4 file system utilities
+ii  elfutils                    0.186-1build1                           amd64        collection of utilities to handle ELF objects
+ii  emacsen-common              3.0.4                                   all          Common facilities for all emacsen
+ii  fd-find                     8.3.1-1ubuntu0.1                        amd64        Simple, fast and user-friendly alternative to find
+ii  file                        1:5.41-3                                amd64        Recognize the type of data in a file using "magic" numbers
+ii  findutils                   4.8.0-1ubuntu3                          amd64        utilities for finding files--find, xargs
+ii  fzf                         0.29.0-1                                amd64        general-purpose command-line fuzzy finder
+ii  g++                         4:11.2.0-1ubuntu1                       amd64        GNU C++ compiler
+ii  g++-11                      11.3.0-1ubuntu1~22.04.1                 amd64        GNU C++ compiler
+ii  g++-11-multilib             11.3.0-1ubuntu1~22.04.1                 amd64        GNU C++ compiler (multilib support)
+ii  g++-multilib                4:11.2.0-1ubuntu1                       amd64        GNU C++ compiler (multilib files)
+ii  gawk                        1:5.1.0-1build3                         amd64        GNU awk, a pattern scanning and processing language
+ii  gcc                         4:11.2.0-1ubuntu1                       amd64        GNU C compiler
+ii  gcc-11                      11.3.0-1ubuntu1~22.04.1                 amd64        GNU C compiler
+ii  gcc-11-base:amd64           11.3.0-1ubuntu1~22.04.1                 amd64        GCC, the GNU Compiler Collection (base package)
+ii  gcc-11-multilib             11.3.0-1ubuntu1~22.04.1                 amd64        GNU C compiler (multilib support)
+ii  gcc-12-base:amd64           12.1.0-2ubuntu1~22.04                   amd64        GCC, the GNU Compiler Collection (base package)
+ii  gcc-12-base:i386            12.1.0-2ubuntu1~22.04                   i386         GCC, the GNU Compiler Collection (base package)
+ii  gcc-multilib                4:11.2.0-1ubuntu1                       amd64        GNU C compiler (multilib files)
+ii  gdb                         12.1-0ubuntu1~22.04                     amd64        GNU Debugger
+ii  git                         1:2.34.1-1ubuntu1.9                     amd64        fast, scalable, distributed revision control system
+ii  git-man                     1:2.34.1-1ubuntu1.9                     all          fast, scalable, distributed revision control system (manual pages)
+ii  gojq                        0.12.6-1                                amd64        pure Go implementation of jq (program)
+ii  gpgv                        2.2.27-3ubuntu2.1                       amd64        GNU privacy guard - signature verification tool
+ii  grep                        3.7-1build1                             amd64        GNU grep, egrep and fgrep
+ii  gzip                        1.10-4ubuntu4.1                         amd64        GNU compression utilities
+ii  hostname                    3.23ubuntu2                             amd64        utility to set/show the host name or domain name
+ii  ht                          2.1.0+repack1-5                         amd64        Viewer/editor/analyser (mostly) for executables
+ii  htop                        3.0.5-7build2                           amd64        interactive processes viewer
+ii  hyperfine                   1.12.0-3ubuntu0.1                       amd64        Command-line benchmarking tool
+ii  init-system-helpers         1.62                                    all          helper tools for all init systems
+ii  jq                          1.6-2.1ubuntu3                          amd64        lightweight and flexible command-line JSON processor
+ii  less                        590-1ubuntu0.22.04.1                    amd64        pager program similar to more
+ii  lib32asan6                  11.3.0-1ubuntu1~22.04.1                 amd64        AddressSanitizer -- a fast memory error detector (32bit)
+ii  lib32atomic1                12.1.0-2ubuntu1~22.04                   amd64        support library providing __atomic built-in functions (32bit)
+ii  lib32gcc-11-dev             11.3.0-1ubuntu1~22.04.1                 amd64        GCC support library (32 bit development files)
+ii  lib32gcc-s1                 12.1.0-2ubuntu1~22.04                   amd64        GCC support library (32 bit Version)
+ii  lib32gomp1                  12.1.0-2ubuntu1~22.04                   amd64        GCC OpenMP (GOMP) support library (32bit)
+ii  lib32itm1                   12.1.0-2ubuntu1~22.04                   amd64        GNU Transactional Memory Library (32bit)
+ii  lib32quadmath0              12.1.0-2ubuntu1~22.04                   amd64        GCC Quad-Precision Math Library (32bit)
+ii  lib32stdc++-11-dev          11.3.0-1ubuntu1~22.04.1                 amd64        GNU Standard C++ Library v3 (development files)
+ii  lib32stdc++6                12.1.0-2ubuntu1~22.04                   amd64        GNU Standard C++ Library v3 (32 bit Version)
+ii  lib32ubsan1                 12.1.0-2ubuntu1~22.04                   amd64        UBSan -- undefined behaviour sanitizer (32bit)
+ii  libacl1:amd64               2.3.1-1                                 amd64        access control list - shared library
+ii  libapt-pkg6.0:amd64         2.4.9                                   amd64        package management runtime library
+ii  libarchive13:amd64          3.6.0-1ubuntu1                          amd64        Multi-format archive and compression library (shared library)
+ii  libaria2-0:amd64            1.36.0-1                                amd64        C++ library interface to aria2
+ii  libasan6:amd64              11.3.0-1ubuntu1~22.04.1                 amd64        AddressSanitizer -- a fast memory error detector
+ii  libasm1:amd64               0.186-1build1                           amd64        library with a programmable assembler interface
+ii  libatomic1:amd64            12.1.0-2ubuntu1~22.04                   amd64        support library providing __atomic built-in functions
+ii  libattr1:amd64              1:2.5.1-1build1                         amd64        extended attribute handling - shared library
+ii  libaudit-common             1:3.0.7-1build1                         all          Dynamic library for security auditing - common files
+ii  libaudit1:amd64             1:3.0.7-1build1                         amd64        Dynamic library for security auditing
+ii  libbabeltrace1:amd64        1.5.8-2build1                           amd64        Babeltrace conversion libraries
+ii  libbinutils:amd64           2.38-4ubuntu2.2                         amd64        GNU binary utilities (private shared library)
+ii  libblkid1:amd64             2.37.2-4ubuntu3                         amd64        block device ID library
+ii  libboost-regex1.74.0:amd64  1.74.0-14ubuntu3                        amd64        regular expression library for C++
+ii  libbrotli1:amd64            1.0.9-2build6                           amd64        library implementing brotli encoder and decoder (shared libraries)
+ii  libbsd0:amd64               0.11.5-1                                amd64        utility functions from BSD systems - shared library
+ii  libbz2-1.0:amd64            1.0.8-5build1                           amd64        high-quality block-sorting file compressor library - runtime
+ii  libc-ares2:amd64            1.18.1-1ubuntu0.22.04.2                 amd64        asynchronous name resolver
+ii  libc-bin                    2.35-0ubuntu3.1                         amd64        GNU C Library: Binaries
+ii  libc-dev-bin                2.35-0ubuntu3.1                         amd64        GNU C Library: Development binaries
+ii  libc6-dev-i386              2.35-0ubuntu3.1                         amd64        GNU C Library: 32-bit development libraries for AMD64
+ii  libc6-dev-x32               2.35-0ubuntu3.1                         amd64        GNU C Library: X32 ABI Development Libraries for AMD64
+ii  libc6-dev:amd64             2.35-0ubuntu3.1                         amd64        GNU C Library: Development Libraries and Header Files
+ii  libc6-i386                  2.35-0ubuntu3.1                         amd64        GNU C Library: 32-bit shared libraries for AMD64
+ii  libc6-x32                   2.35-0ubuntu3.1                         amd64        GNU C Library: X32 ABI Shared libraries for AMD64
+ii  libc6:amd64                 2.35-0ubuntu3.1                         amd64        GNU C Library: Shared libraries
+ii  libc6:i386                  2.35-0ubuntu3.1                         i386         GNU C Library: Shared libraries
+ii  libcap-ng0:amd64            0.7.9-2.2build3                         amd64        An alternate POSIX capabilities library
+ii  libcap2:amd64               1:2.44-1ubuntu0.22.04.1                 amd64        POSIX 1003.1e capabilities (library)
+ii  libcc1-0:amd64              12.1.0-2ubuntu1~22.04                   amd64        GCC cc1 plugin for GDB
+ii  libcom-err2:amd64           1.46.5-2ubuntu1.1                       amd64        common error description library
+ii  libcrypt-dev:amd64          1:4.4.27-1                              amd64        libcrypt development files
+ii  libcrypt1:amd64             1:4.4.27-1                              amd64        libcrypt shared library
+ii  libcrypt1:i386              1:4.4.27-1                              i386         libcrypt shared library
+ii  libctf-nobfd0:amd64         2.38-4ubuntu2.2                         amd64        Compact C Type Format library (runtime, no BFD dependency)
+ii  libctf0:amd64               2.38-4ubuntu2.2                         amd64        Compact C Type Format library (runtime, BFD dependency)
+ii  libcurl3-gnutls:amd64       7.81.0-1ubuntu1.13                      amd64        easy-to-use client-side URL transfer library (GnuTLS flavour)
+ii  libcurl4:amd64              7.81.0-1ubuntu1.13                      amd64        easy-to-use client-side URL transfer library (OpenSSL flavour)
+ii  libdb5.3:amd64              5.3.28+dfsg1-0.8ubuntu3                 amd64        Berkeley v5.3 Database Libraries [runtime]
+ii  libdebconfclient0:amd64     0.261ubuntu1                            amd64        Debian Configuration Management System (C-implementation library)
+ii  libdebuginfod-common        0.186-1build1                           all          configuration to enable the Debian debug info server
+ii  libdebuginfod1:amd64        0.186-1build1                           amd64        library to interact with debuginfod (development files)
+ii  libdw1:amd64                0.186-1build1                           amd64        library that provides access to the DWARF debug information
+ii  libelf1:amd64               0.186-1build1                           amd64        library to read and write ELF files
+ii  liberror-perl               0.17029-1                               all          Perl module for error/exception handling in an OO-ish way
+ii  libexpat1:amd64             2.4.7-1ubuntu0.2                        amd64        XML parsing C library - runtime library
+ii  libext2fs2:amd64            1.46.5-2ubuntu1.1                       amd64        ext2/ext3/ext4 file system libraries
+ii  libffi8:amd64               3.4.2-4                                 amd64        Foreign Function Interface library runtime
+ii  libgcc-11-dev:amd64         11.3.0-1ubuntu1~22.04.1                 amd64        GCC support library (development files)
+ii  libgcc-s1:amd64             12.1.0-2ubuntu1~22.04                   amd64        GCC support library
+ii  libgcc-s1:i386              12.1.0-2ubuntu1~22.04                   i386         GCC support library
+ii  libgcrypt20:amd64           1.9.4-3ubuntu3                          amd64        LGPL Crypto library - runtime library
+ii  libgdbm-compat4:amd64       1.23-1                                  amd64        GNU dbm database routines (legacy support runtime version)
+ii  libgdbm6:amd64              1.23-1                                  amd64        GNU dbm database routines (runtime version)
+ii  libglib2.0-0:amd64          2.72.4-0ubuntu2.2                       amd64        GLib library of C routines
+ii  libgmp10:amd64              2:6.2.1+dfsg-3ubuntu1                   amd64        Multiprecision arithmetic library
+ii  libgnutls30:amd64           3.7.3-4ubuntu1.2                        amd64        GNU TLS library - main runtime library
+ii  libgomp1:amd64              12.1.0-2ubuntu1~22.04                   amd64        GCC OpenMP (GOMP) support library
+ii  libgpg-error0:amd64         1.43-3                                  amd64        GnuPG development runtime library
+ii  libgpm2:amd64               1.20.7-10build1                         amd64        General Purpose Mouse - shared library
+ii  libgssapi-krb5-2:amd64      1.19.2-2ubuntu0.2                       amd64        MIT Kerberos runtime libraries - krb5 GSS-API Mechanism
+ii  libhiredis0.14:amd64        0.14.1-2                                amd64        minimalistic C client library for Redis
+ii  libhogweed6:amd64           3.7.3-1build2                           amd64        low level cryptographic library (public-key cryptos)
+ii  libicu70:amd64              70.1-2                                  amd64        International Components for Unicode
+ii  libidn2-0:amd64             2.3.2-2build1                           amd64        Internationalized domain names (IDNA2008/TR46) library
+ii  libio-pty-perl              1:1.15-2build2                          amd64        Perl module for pseudo tty IO
+ii  libipc-run-perl             20200505.0-1                            all          Perl module for running processes
+ii  libipt2                     2.0.5-1                                 amd64        Intel Processor Trace Decoder Library
+ii  libisl23:amd64              0.24-2build1                            amd64        manipulating sets and relations of integer points bounded by linear constraints
+ii  libitm1:amd64               12.1.0-2ubuntu1~22.04                   amd64        GNU Transactional Memory Library
+ii  libjansson4:amd64           2.13.1-1.1build3                        amd64        C library for encoding, decoding and manipulating JSON data
+ii  libjq1:amd64                1.6-2.1ubuntu3                          amd64        lightweight and flexible command-line JSON processor - shared library
+ii  libjsoncpp25:amd64          1.9.5-3                                 amd64        library for reading and writing JSON for C++
+ii  libk5crypto3:amd64          1.19.2-2ubuntu0.2                       amd64        MIT Kerberos runtime libraries - Crypto Library
+ii  libkeyutils1:amd64          1.6.1-2ubuntu3                          amd64        Linux Key Management Utilities (library)
+ii  libkrb5-3:amd64             1.19.2-2ubuntu0.2                       amd64        MIT Kerberos runtime libraries
+ii  libkrb5support0:amd64       1.19.2-2ubuntu0.2                       amd64        MIT Kerberos runtime libraries - Support library
+ii  libldap-2.5-0:amd64         2.5.14+dfsg-0ubuntu0.22.04.2            amd64        OpenLDAP libraries
+ii  liblsan0:amd64              12.1.0-2ubuntu1~22.04                   amd64        LeakSanitizer -- a memory leak detector (runtime)
+ii  liblz4-1:amd64              1.9.3-2build2                           amd64        Fast LZ compression algorithm library - runtime
+ii  liblzma5:amd64              5.2.5-2ubuntu1                          amd64        XZ-format compression library
+ii  liblzo2-2:amd64             2.10-2build3                            amd64        data compression library
+ii  libmagic-mgc                1:5.41-3                                amd64        File type determination library using "magic" numbers (compiled magic file)
+ii  libmagic1:amd64             1:5.41-3                                amd64        Recognize the type of data in a file using "magic" numbers - library
+ii  libmd0:amd64                1.0.4-1build1                           amd64        message digest functions from BSD systems - shared library
+ii  libmount1:amd64             2.37.2-4ubuntu3                         amd64        device mounting library
+ii  libmpc3:amd64               1.2.1-2build1                           amd64        multiple precision complex floating-point library
+ii  libmpdec3:amd64             2.5.1-2build2                           amd64        library for decimal floating point arithmetic (runtime library)
+ii  libmpfr6:amd64              4.1.0-3build3                           amd64        multiple precision floating-point computation
+ii  libmspack0:amd64            0.10.1-2build2                          amd64        library for Microsoft compression formats (shared library)
+ii  libncurses5:amd64           6.3-2ubuntu0.1                          amd64        shared libraries for terminal handling (legacy version)
+ii  libncurses6:amd64           6.3-2ubuntu0.1                          amd64        shared libraries for terminal handling
+ii  libncursesw6:amd64          6.3-2ubuntu0.1                          amd64        shared libraries for terminal handling (wide character support)
+ii  libnettle8:amd64            3.7.3-1build2                           amd64        low level cryptographic library (symmetric and one-way cryptos)
+ii  libnghttp2-14:amd64         1.43.0-1build3                          amd64        library implementing HTTP/2 protocol (shared library)
+ii  libnl-3-200:amd64           3.5.0-0.1                               amd64        library for dealing with netlink sockets
+ii  libnl-genl-3-200:amd64      3.5.0-0.1                               amd64        library for dealing with netlink sockets - generic netlink
+ii  libnsl-dev:amd64            1.3.0-2build2                           amd64        libnsl development files
+ii  libnsl2:amd64               1.3.0-2build2                           amd64        Public client interface for NIS(YP) and NIS+
+ii  libonig5:amd64              6.9.7.1-2build1                         amd64        regular expressions library
+ii  libp11-kit0:amd64           0.24.0-6build1                          amd64        library for loading and coordinating access to PKCS#11 modules - runtime
+ii  libpam-modules-bin          1.4.0-11ubuntu2.3                       amd64        Pluggable Authentication Modules for PAM - helper binaries
+ii  libpam-modules:amd64        1.4.0-11ubuntu2.3                       amd64        Pluggable Authentication Modules for PAM
+ii  libpam-runtime              1.4.0-11ubuntu2.3                       all          Runtime support for the PAM library
+ii  libpam0g:amd64              1.4.0-11ubuntu2.3                       amd64        Pluggable Authentication Modules library
+ii  libpcre2-8-0:amd64          10.39-3ubuntu0.1                        amd64        New Perl Compatible Regular Expression Library- 8 bit runtime files
+ii  libpcre3:amd64              2:8.39-13ubuntu0.22.04.1                amd64        Old Perl 5 Compatible Regular Expression Library - runtime files
+ii  libperl5.34:amd64           5.34.0-3ubuntu1.2                       amd64        shared Perl library
+ii  libpopt0:amd64              1.18-3build1                            amd64        lib for parsing cmdline parameters
+ii  libprocps8:amd64            2:3.3.17-6ubuntu2                       amd64        library for accessing process information from /proc
+ii  libpsl5:amd64               0.21.0-1.2build2                        amd64        Library for Public Suffix List (shared libraries)
+ii  libpython2.7-minimal:amd64  2.7.18-13ubuntu1.1                      amd64        Minimal subset of the Python language (version 2.7)
+ii  libpython3-stdlib:amd64     3.10.6-1~22.04                          amd64        interactive high-level object-oriented language (default python3 version)
+ii  libpython3.10-minimal:amd64 3.10.6-1~22.04.2ubuntu1.1               amd64        Minimal subset of the Python language (version 3.10)
+ii  libpython3.10-stdlib:amd64  3.10.6-1~22.04.2ubuntu1.1               amd64        Interactive high-level object-oriented language (standard library, version 3.10)
+ii  libpython3.10:amd64         3.10.6-1~22.04.2ubuntu1.1               amd64        Shared Python runtime library (version 3.10)
+ii  libquadmath0:amd64          12.1.0-2ubuntu1~22.04                   amd64        GCC Quad-Precision Math Library
+ii  libreadline8:amd64          8.1.2-1                                 amd64        GNU readline and history libraries, run-time libraries
+ii  librhash0:amd64             1.4.2-1ubuntu1                          amd64        shared library for hash functions computing
+ii  librtmp1:amd64              2.4+20151223.gitfa8646d.1-2build4       amd64        toolkit for RTMP streams (shared library)
+ii  libsasl2-2:amd64            2.1.27+dfsg2-3ubuntu1.2                 amd64        Cyrus SASL - authentication abstraction library
+ii  libsasl2-modules-db:amd64   2.1.27+dfsg2-3ubuntu1.2                 amd64        Cyrus SASL - pluggable authentication modules (DB)
+ii  libseccomp2:amd64           2.5.3-2ubuntu2                          amd64        high level interface to Linux seccomp filter
+ii  libselinux1:amd64           3.3-1build2                             amd64        SELinux runtime shared libraries
+ii  libsemanage-common          3.3-1build2                             all          Common files for SELinux policy management libraries
+ii  libsemanage2:amd64          3.3-1build2                             amd64        SELinux policy management library
+ii  libsensors-config           1:3.6.0-7ubuntu1                        all          lm-sensors configuration files
+ii  libsensors5:amd64           1:3.6.0-7ubuntu1                        amd64        library to read temperature/voltage/fan sensors
+ii  libsepol2:amd64             3.3-1build1                             amd64        SELinux library for manipulating binary security policies
+ii  libsigsegv2:amd64           2.13-1ubuntu3                           amd64        Library for handling page faults in a portable way
+ii  libsmartcols1:amd64         2.37.2-4ubuntu3                         amd64        smart column output alignment library
+ii  libsodium23:amd64           1.0.18-1build2                          amd64        Network communication, cryptography and signaturing library
+ii  libsource-highlight-common  3.1.9-4.1build2                         all          architecture-independent files for source highlighting library
+ii  libsource-highlight4v5      3.1.9-4.1build2                         amd64        source highlighting library
+ii  libsqlite3-0:amd64          3.37.2-2ubuntu0.1                       amd64        SQLite 3 shared library
+ii  libss2:amd64                1.46.5-2ubuntu1.1                       amd64        command-line interface parsing library
+ii  libssh-4:amd64              0.9.6-2ubuntu0.22.04.1                  amd64        tiny C SSH library (OpenSSL flavor)
+ii  libssh2-1:amd64             1.10.0-3                                amd64        SSH2 client-side library
+ii  libssl3:amd64               3.0.2-0ubuntu1.10                       amd64        Secure Sockets Layer toolkit - shared libraries
+ii  libstdc++-11-dev:amd64      11.3.0-1ubuntu1~22.04.1                 amd64        GNU Standard C++ Library v3 (development files)
+ii  libstdc++6:amd64            12.1.0-2ubuntu1~22.04                   amd64        GNU Standard C++ Library v3
+ii  libsystemd0:amd64           249.11-0ubuntu3.9                       amd64        systemd utility library
+ii  libtasn1-6:amd64            4.18.0-4build1                          amd64        Manage ASN.1 structures (runtime)
+ii  libtime-duration-perl       1.21-1                                  all          module for rounded or exact English expression of durations
+ii  libtimedate-perl            2.3300-2                                all          collection of modules to manipulate date/time information
+ii  libtinfo5:amd64             6.3-2ubuntu0.1                          amd64        shared low-level terminfo library (legacy version)
+ii  libtinfo6:amd64             6.3-2ubuntu0.1                          amd64        shared low-level terminfo library for terminal handling
+ii  libtirpc-common             1.3.2-2ubuntu0.1                        all          transport-independent RPC library - common files
+ii  libtirpc-dev:amd64          1.3.2-2ubuntu0.1                        amd64        transport-independent RPC library - development files
+ii  libtirpc3:amd64             1.3.2-2ubuntu0.1                        amd64        transport-independent RPC library
+ii  libtsan0:amd64              11.3.0-1ubuntu1~22.04.1                 amd64        ThreadSanitizer -- a Valgrind-based detector of data races (runtime)
+ii  libubsan1:amd64             12.1.0-2ubuntu1~22.04                   amd64        UBSan -- undefined behaviour sanitizer (runtime)
+ii  libudev1:amd64              249.11-0ubuntu3.9                       amd64        libudev shared library
+ii  libunistring2:amd64         1.0-1                                   amd64        Unicode string library for C
+ii  libutempter0:amd64          1.2.1-2build2                           amd64        privileged helper for utmp/wtmp updates (runtime)
+ii  libuuid1:amd64              2.37.2-4ubuntu3                         amd64        Universally Unique ID library
+ii  libuv1:amd64                1.43.0-1                                amd64        asynchronous event notification library - runtime library
+ii  libx11-6:amd64              2:1.7.5-1ubuntu0.2                      amd64        X11 client-side library
+ii  libx11-data                 2:1.7.5-1ubuntu0.2                      all          X11 client-side library
+ii  libx32asan6                 11.3.0-1ubuntu1~22.04.1                 amd64        AddressSanitizer -- a fast memory error detector (x32)
+ii  libx32atomic1               12.1.0-2ubuntu1~22.04                   amd64        support library providing __atomic built-in functions (x32)
+ii  libx32gcc-11-dev            11.3.0-1ubuntu1~22.04.1                 amd64        GCC support library (x32 development files)
+ii  libx32gcc-s1                12.1.0-2ubuntu1~22.04                   amd64        GCC support library (x32)
+ii  libx32gomp1                 12.1.0-2ubuntu1~22.04                   amd64        GCC OpenMP (GOMP) support library (x32)
+ii  libx32itm1                  12.1.0-2ubuntu1~22.04                   amd64        GNU Transactional Memory Library (x32)
+ii  libx32quadmath0             12.1.0-2ubuntu1~22.04                   amd64        GCC Quad-Precision Math Library (x32)
+ii  libx32stdc++-11-dev         11.3.0-1ubuntu1~22.04.1                 amd64        GNU Standard C++ Library v3 (development files)
+ii  libx32stdc++6               12.1.0-2ubuntu1~22.04                   amd64        GNU Standard C++ Library v3 (x32)
+ii  libx32ubsan1                12.1.0-2ubuntu1~22.04                   amd64        UBSan -- undefined behaviour sanitizer (x32)
+ii  libxau6:amd64               1:1.0.9-1build5                         amd64        X11 authorisation library
+ii  libxcb1:amd64               1.14-3ubuntu3                           amd64        X C Binding
+ii  libxdmcp6:amd64             1:1.1.3-0ubuntu5                        amd64        X11 Display Manager Control Protocol library
+ii  libxml2:amd64               2.9.13+dfsg-1ubuntu0.3                  amd64        GNOME XML library
+ii  libxxhash0:amd64            0.8.1-1                                 amd64        shared library for xxhash
+ii  libyaml-0-2:amd64           0.2.2-1build2                           amd64        Fast YAML 1.1 parser and emitter library
+ii  libzstd-dev:amd64           1.4.8+dfsg-3build1                      amd64        fast lossless compression algorithm -- development files
+ii  libzstd1:amd64              1.4.8+dfsg-3build1                      amd64        fast lossless compression algorithm
+ii  linux-libc-dev:amd64        5.15.0-76.83                            amd64        Linux Kernel Headers for development
+ii  login                       1:4.8.1-2ubuntu2.1                      amd64        system login tools
+ii  logsave                     1.46.5-2ubuntu1.1                       amd64        save the output of a command in a log file
+ii  lsb-base                    11.1.0ubuntu4                           all          Linux Standard Base init script functionality
+ii  lsb-release                 11.1.0ubuntu4                           all          Linux Standard Base version reporting utility
+ii  lz4                         1.9.3-2build2                           amd64        Fast LZ compression algorithm library - tool
+ii  lzip                        1.23-1                                  amd64        lossless data compressor based on the LZMA algorithm
+ii  lzop                        1.04-2build2                            amd64        fast compression program
+ii  make                        4.3-4.1build1                           amd64        utility for directing compilation
+ii  mawk                        1.3.4.20200120-3                        amd64        Pattern scanning and text processing language
+ii  media-types                 7.0.0                                   all          List of standard media types and their usual file extension
+ii  mksh                        59c-16                                  amd64        MirBSD Korn Shell
+ii  moreutils                   0.66-1                                  amd64        additional Unix utilities
+ii  mount                       2.37.2-4ubuntu3                         amd64        tools for mounting and manipulating filesystems
+ii  ncurses-base                6.3-2ubuntu0.1                          all          basic terminal type definitions
+ii  ncurses-bin                 6.3-2ubuntu0.1                          amd64        terminal-related programs and man pages
+ii  ncurses-term                6.3-2ubuntu0.1                          all          additional terminal type definitions
+ii  ninja-build                 1.10.1-1                                amd64        small build system closest in spirit to Make
+ii  openssl                     3.0.2-0ubuntu1.10                       amd64        Secure Sockets Layer toolkit - cryptographic utility
+ii  p7zip                       16.02+dfsg-8                            amd64        7zr file archiver with high compression ratio
+ii  parallel                    20210822+ds-2                           all          build and execute command lines from standard input in parallel
+ii  passwd                      1:4.8.1-2ubuntu2.1                      amd64        change and administer password and group data
+ii  patch                       2.7.6-7build2                           amd64        Apply a diff file to an original
+ii  patchelf                    0.14.3-1                                amd64        modify properties of ELF executables
+ii  pax-utils                   1.2.9-1                                 amd64        Security-focused ELF files checking tool
+ii  paxctl                      0.9-1build1                             amd64        new PaX control program for using the PT_PAX_FLAGS marking
+ii  perl                        5.34.0-3ubuntu1.2                       amd64        Larry Wall's Practical Extraction and Report Language
+ii  perl-base                   5.34.0-3ubuntu1.2                       amd64        minimal Perl system
+ii  perl-modules-5.34           5.34.0-3ubuntu1.2                       all          Core Perl modules
+ii  procps                      2:3.3.17-6ubuntu2                       amd64        /proc file system utilities
+ii  python2-minimal             2.7.18-3                                amd64        minimal subset of the Python2 language
+ii  python2.7-minimal           2.7.18-13ubuntu1.1                      amd64        Minimal subset of the Python language (version 2.7)
+ii  python3                     3.10.6-1~22.04                          amd64        interactive high-level object-oriented language (default python3 version)
+ii  python3-minimal             3.10.6-1~22.04                          amd64        minimal subset of the Python language (default python3 version)
+ii  python3.10                  3.10.6-1~22.04.2ubuntu1.1               amd64        Interactive high-level object-oriented language (version 3.10)
+ii  python3.10-minimal          3.10.6-1~22.04.2ubuntu1.1               amd64        Minimal subset of the Python language (version 3.10)
+ii  re2c                        3.0-1                                   amd64        lexer generator for C, C++, Go and Rust
+ii  readline-common             8.1.2-1                                 all          GNU readline and history libraries, common files
+ii  ripgrep                     13.0.0-2ubuntu0.1                       amd64        Recursively searches directories for a regex pattern
+ii  rpcsvc-proto                1.4.2-0ubuntu6                          amd64        RPC protocol compiler and definitions
+ii  rsync                       3.2.7-0ubuntu0.22.04.2                  amd64        fast, versatile, remote (and local) file-copying tool
+ii  screen                      4.9.0-1                                 amd64        terminal multiplexer with VT100/ANSI terminal emulation
+ii  sed                         4.8-1ubuntu2                            amd64        GNU stream editor for filtering/transforming text
+ii  sensible-utils              0.0.17                                  all          Utilities for sensible alternative selection
+ii  sysstat                     12.5.2-2ubuntu0.2                       amd64        system performance tools for Linux
+ii  sysvinit-utils              3.01-1ubuntu1                           amd64        System-V-like utilities
+ii  tar                         1.34+dfsg-1ubuntu0.1.22.04.1            amd64        GNU version of the tar archiving utility
+ii  time                        1.9-0.1build2                           amd64        GNU time program for measuring CPU resource usage
+ii  ubuntu-keyring              2021.03.26                              all          GnuPG keys of the Ubuntu archive
+ii  ucf                         3.0043                                  all          Update Configuration File(s): preserve user changes to config files
+ii  universal-ctags             5.9.20210829.0-1                        amd64        build tag file indexes of source code definitions
+ii  unzip                       6.0-26ubuntu3.1                         amd64        De-archiver for .zip files
+ii  usrmerge                    25ubuntu2                               all          Convert the system to the merged /usr directories scheme
+ii  util-linux                  2.37.2-4ubuntu3                         amd64        miscellaneous system utilities
+ii  vim                         2:8.2.3995-1ubuntu2.9                   amd64        Vi IMproved - enhanced vi editor
+ii  vim-common                  2:8.2.3995-1ubuntu2.9                   all          Vi IMproved - Common files
+ii  vim-runtime                 2:8.2.3995-1ubuntu2.9                   all          Vi IMproved - Runtime files
+ii  wget                        1.21.2-2ubuntu1                         amd64        retrieves files from the web
+ii  xxd                         2:8.2.3995-1ubuntu2.9                   amd64        tool to make (or reverse) a hex dump
+ii  xz-utils                    5.2.5-2ubuntu1                          amd64        XZ-format compression utilities
+ii  yash                        2.51-1                                  amd64        yet another shell
+ii  zip                         3.0-12build2                            amd64        Archiver for .zip files
+ii  zlib1g-dev:amd64            1:1.2.11.dfsg-2ubuntu9.2                amd64        compression library - development
+ii  zlib1g:amd64                1:1.2.11.dfsg-2ubuntu9.2                amd64        compression library - runtime
+ii  zlib1g:i386                 1:1.2.11.dfsg-2ubuntu9.2                i386         compression library - runtime
+ii  zsh                         5.8.1-1                                 amd64        shell with lots of features
+ii  zsh-common                  5.8.1-1                                 all          architecture independent files for Zsh
+ii  zstd                        1.4.8+dfsg-3build1                      amd64        fast lossless compression algorithm -- CLI tool
+| Status=Not/Inst/Conf-files/Unpacked/halF-conf/Half-inst/trig-aWait/Trig-pend
+|/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)
+||/ Name                        Version                                 Architecture Description
+
+Packages sorted by Installed-Size:
+   748809 ===== TOTAL (321 packages)
+    52577 gcc-11                                   amd64
+    34444 libicu70                                 amd64
+    32780 vim-runtime                              all
+    28795 g++-11                                   amd64
+    28441 libperl5.34                              amd64
+    26212 cpp-11                                   amd64
+    20742 cmake                                    amd64
+    18721 libstdc++-11-dev                         amd64
+    18468 git                                      amd64
+    17671 perl-modules-5.34                        all
+    15293 zsh-common                               all
+    13894 libgcc-11-dev                            amd64
+    13592 libc6                                    amd64
+    13037 libc6-dev                                amd64
+    12561 libc6-x32                                amd64
+    12479 libc6                                    i386
+    12200 libc6-i386                               amd64
+    11311 gdb                                      amd64
+    10876 lib32stdc++-11-dev                       amd64
+    10439 binutils-x86-64-linux-gnu                amd64
+    10391 libx32stdc++-11-dev                      amd64
+     9866 cmake-data                               all
+     8248 libc6-dev-x32                            amd64
+     8040 libpython3.10-stdlib                     amd64
+     7947 lib32gcc-11-dev                          amd64
+     7730 perl-base                                amd64
+     7518 libasan6                                 amd64
+     7261 libc6-dev-i386                           amd64
+     7255 libtsan0                                 amd64
+     7127 libmagic-mgc                             amd64
+     7112 coreutils                                amd64
+     6988 libx32gcc-11-dev                         amd64
+     6734 linux-libc-dev                           amd64
+     6733 dpkg                                     amd64
+     6659 lib32asan6                               amd64
+     6570 libx32asan6                              amd64
+     5902 python3.10-minimal                       amd64
+     5824 libssl3                                  amd64
+     5780 libpython3.10                            amd64
+     5093 libpython3.10-minimal                    amd64
+     4249 ncurses-term                             all
+     4156 apt                                      amd64
+     4147 ripgrep                                  amd64
+     4082 libglib2.0-0                             amd64
+     3923 vim                                      amd64
+     3643 python2.7-minimal                        amd64
+     3506 re2c                                     amd64
+     3487 gojq                                     amd64
+     3405 libmpfr6                                 amd64
+     3399 util-linux                               amd64
+     3347 libaria2-0                               amd64
+     3181 libapt-pkg6.0                            amd64
+     3013 libboost-regex1.74.0                     amd64
+     2961 liblsan0                                 amd64
+     2943 parallel                                 all
+     2801 elfutils                                 amd64
+     2784 libpython2.7-minimal                     amd64
+     2776 libbinutils                              amd64
+     2746 libstdc++6                               amd64
+     2675 libubsan1                                amd64
+     2662 lib32stdc++6                             amd64
+     2537 libc-bin                                 amd64
+     2518 libx32ubsan1                             amd64
+     2510 fd-find                                  amd64
+     2500 lib32ubsan1                              amd64
+     2468 zsh                                      amd64
+     2438 libx32stdc++6                            amd64
+     2428 fzf                                      amd64
+     2396 7zip                                     amd64
+     2325 passwd                                   amd64
+     2284 libgnutls30                              amd64
+     2191 ht                                       amd64
+     2159 libisl23                                 amd64
+     2097 libxml2                                  amd64
+     2053 openssl                                  amd64
+     2009 universal-ctags                          amd64
+     1959 git-man                                  all
+     1864 bash                                     amd64
+     1854 aria2                                    amd64
+     1750 libdb5.3                                 amd64
+     1746 libunistring2                            amd64
+     1680 gawk                                     amd64
+     1655 zstd                                     amd64
+     1602 libsqlite3-0                             amd64
+     1516 e2fsprogs                                amd64
+     1508 mksh                                     amd64
+     1472 sysstat                                  amd64
+     1464 bash-completion                          all
+     1445 hyperfine                                amd64
+     1429 yash                                     amd64
+     1429 libx11-data                              all
+     1388 procps                                   amd64
+     1386 libx11-6                                 amd64
+     1354 libgcrypt20                              amd64
+     1343 ccache                                   amd64
+     1328 libzstd-dev                              amd64
+     1292 libp11-kit0                              amd64
+     1138 libpam-modules                           amd64
+     1052 libkrb5-3                                amd64
+     1005 screen                                   amd64
+      995 libsystemd0                              amd64
+      990 p7zip                                    amd64
+      984 wget                                     amd64
+      960 tar                                      amd64
+      888 login                                    amd64
+      876 libarchive13                             amd64
+      846 libzstd1                                 amd64
+      794 rsync                                    amd64
+      791 busybox                                  amd64
+      787 libcurl4                                 amd64
+      784 libbrotli1                               amd64
+      771 libcurl3-gnutls                          amd64
+      735 libsepol2                                amd64
+      729 libdw1                                   amd64
+      720 libtirpc-dev                             amd64
+      717 perl                                     amd64
+      686 lib32quadmath0                           amd64
+      683 libpcre3                                 amd64
+      646 ncurses-bin                              amd64
+      621 libpcre2-8-0                             amd64
+      620 python3.10                               amd64
+      620 findutils                                amd64
+      615 libonig5                                 amd64
+      610 libsource-highlight4v5                   amd64
+      608 adduser                                  all
+      592 zlib1g-dev                               amd64
+      574 libext2fs2                               amd64
+      565 libldap-2.5-0                            amd64
+      558 libtinfo6                                amd64
+      544 libtinfo5                                amd64
+      544 libgmp10                                 amd64
+      531 zip                                      amd64
+      512 debconf                                  all
+      504 binutils-common                          amd64
+      502 libbabeltrace1                           amd64
+      496 grep                                     amd64
+      486 libssh-4                                 amd64
+      461 libreadline8                             amd64
+      455 libgssapi-krb5-2                         amd64
+      443 curl                                     amd64
+      433 libexpat1                                amd64
+      424 diffutils                                amd64
+      422 libncursesw6                             amd64
+      416 make                                     amd64
+      402 libsodium23                              amd64
+      394 base-files                               amd64
+      393 ncurses-base                             all
+      390 ca-certificates                          all
+      389 mount                                    amd64
+      382 libmount1                                amd64
+      379 vim-common                               all
+      376 unzip                                    amd64
+      372 xz-utils                                 amd64
+      368 libssh2-1                                amd64
+      356 libnettle8                               amd64
+      350 ninja-build                              amd64
+      347 libudev1                                 amd64
+      347 libnsl-dev                               amd64
+      347 libjq1                                   amd64
+      336 libhogweed6                              amd64
+      334 lib32gomp1                               amd64
+      334 htop                                     amd64
+      334 bsdutils                                 amd64
+      329 libncurses6                              amd64
+      328 sed                                      amd64
+      324 gpgv                                     amd64
+      324 cpio                                     amd64
+      323 libblkid1                                amd64
+      321 less                                     amd64
+      320 libgomp1                                 amd64
+      320 libcrypt-dev                             amd64
+      318 libncurses5                              amd64
+      312 libpam-runtime                           all
+      312 libctf-nobfd0                            amd64
+      307 libsource-highlight-common               all
+      306 libx32gomp1                              amd64
+      300 libsemanage2                             amd64
+      298 libc-dev-bin                             amd64
+      296 libquadmath0                             amd64
+      292 libk5crypto3                             amd64
+      291 libx32quadmath0                          amd64
+      290 pax-utils                                amd64
+      290 liblzma5                                 amd64
+      277 xxd                                      amd64
+      271 gcc-11-base                              amd64
+      266 gcc-12-base                              i386
+      266 gcc-12-base                              amd64
+      252 libuv1                                   amd64
+      252 libipc-run-perl                          all
+      252 libcrypt1                                i386
+      250 libmpdec3                                amd64
+      248 libpam-modules-bin                       amd64
+      245 rpcsvc-proto                             amd64
+      243 debianutils                              amd64
+      243 base-passwd                              amd64
+      240 moreutils                                amd64
+      240 gzip                                     amd64
+      239 libctf0                                  amd64
+      235 libpam0g                                 amd64
+      235 libjsoncpp25                             amd64
+      232 ucf                                      all
+      230 lz4                                      amd64
+      229 patch                                    amd64
+      229 mawk                                     amd64
+      228 libmagic1                                amd64
+      225 libcrypt1                                amd64
+      221 bfs                                      amd64
+      220 libidn2-0                                amd64
+      219 libtirpc3                                amd64
+      219 librhash0                                amd64
+      214 dash                                     amd64
+      209 libsmartcols1                            amd64
+      207 libselinux1                              amd64
+      206 libxcb1                                  amd64
+      203 libnghttp2-14                            amd64
+      200 usrmerge                                 all
+      192 libelf1                                  amd64
+      189 libgpg-error0                            amd64
+      182 patchelf                                 amd64
+      180 libnl-3-200                              amd64
+      171 zlib1g                                   i386
+      170 libsasl2-2                               amd64
+      167 libgcc-s1                                i386
+      164 zlib1g                                   amd64
+      164 libkrb5support0                          amd64
+      163 lib32gcc-s1                              amd64
+      161 lzip                                     amd64
+      159 lzop                                     amd64
+      159 liblzo2-2                                amd64
+      156 libaudit1                                amd64
+      145 libseccomp2                              amd64
+      145 liblz4-1                                 amd64
+      144 libyaml-0-2                              amd64
+      144 libcc1-0                                 amd64
+      141 librtmp1                                 amd64
+      140 libgcc-s1                                amd64
+      136 libbsd0                                  amd64
+      135 libx32gcc-s1                             amd64
+      134 libuuid1                                 amd64
+      133 libtasn1-6                               amd64
+      133 init-system-helpers                      all
+      132 libipt2                                  amd64
+      131 libprocps8                               amd64
+      126 time                                     amd64
+      125 libmpc3                                  amd64
+      123 libtimedate-perl                         all
+      123 libnsl2                                  amd64
+      122 python3-minimal                          amd64
+      120 libpopt0                                 amd64
+      115 libitm1                                  amd64
+      114 bzip2                                    amd64
+      113 libss2                                   amd64
+      113 lib32itm1                                amd64
+      112 libc-ares2                               amd64
+      112 binutils                                 amd64
+      110 libio-pty-perl                           amd64
+      105 python2-minimal                          amd64
+      105 libx32itm1                               amd64
+      101 libcom-err2                              amd64
+      100 libgdbm6                                 amd64
+      100 libbz2-1.0                               amd64
+      100 jq                                       amd64
+       97 media-types                              all
+       97 logsave                                  amd64
+       97 libxxhash0                               amd64
+       96 libsensors5                              amd64
+       96 libmspack0                               amd64
+       95 libpsl5                                  amd64
+       93 libsasl2-modules-db                      amd64
+       92 libhiredis0.14                           amd64
+       91 libjansson4                              amd64
+       90 python3                                  amd64
+       83 sysvinit-utils                           amd64
+       83 file                                     amd64
+       82 cabextract                               amd64
+       80 readline-common                          all
+       79 libdebconfclient0                        amd64
+       74 libasm1                                  amd64
+       71 libmd0                                   amd64
+       71 liberror-perl                            all
+       69 libffi8                                  amd64
+       67 libacl1                                  amd64
+       67 cpp                                      amd64
+       66 lsb-release                              all
+       65 libgpm2                                  amd64
+       65 libdebuginfod1                           amd64
+       65 libcap2                                  amd64
+       62 emacsen-common                           all
+       61 libnl-genl-3-200                         amd64
+       59 sensible-utils                           all
+       58 lsb-base                                 all
+       57 libattr1                                 amd64
+       51 libutempter0                             amd64
+       51 hostname                                 amd64
+       50 gcc                                      amd64
+       49 libsigsegv2                              amd64
+       47 libkeyutils1                             amd64
+       45 libgdbm-compat4                          amd64
+       45 libcap-ng0                               amd64
+       45 libatomic1                               amd64
+       43 libxdmcp6                                amd64
+       43 libx32atomic1                            amd64
+       42 libsensors-config                        all
+       41 ubuntu-keyring                           all
+       41 libdebuginfod-common                     all
+       39 libpython3-stdlib                        amd64
+       39 lib32atomic1                             amd64
+       37 libsemanage-common                       all
+       37 chrpath                                  amd64
+       35 libxau6                                  amd64
+       35 libtime-duration-perl                    all
+       32 libtirpc-common                          all
+       30 paxctl                                   amd64
+       27 dh-elpa-helper                           all
+       23 libaudit-common                          all
+       20 distro-info-data                         all
+       16 g++                                      amd64
+        8 gcc-multilib                             amd64
+        6 gcc-11-multilib                          amd64
+        6 g++-multilib                             amd64
+        6 g++-11-multilib                          amd64

misc/scripts/build_upx_by_hand.sh

@@ -0,0 +1,127 @@
+#! /bin/sh
+## vim:set ts=4 sw=4 et:
+set -e
+
+#
+# build UPX "by hand", using a POSIX-compliant shell and
+# a minimal number of compilation flags
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+#
+
+# uses optional environment variables: AR, CC, CXX, OPTIMIZE, top_srcdir
+
+# shell init
+### set -x # enable logging
+DUALCASE=1; export DUALCASE # for MKS sh
+test -n "${ZSH_VERSION+set}" && emulate sh # for zsh
+my_argv0="$0"
+
+# toolchain settings and compilation flags
+AR="${AR:-ar}"
+CC="${CC:-cc}"
+CXX="${CXX:-c++ -std=gnu++17}"
+# HINT: use "export AR=false" if "$AR rcs" does not work on your system; see below
+if test "x$AR" = "x0" || test "x$AR" = "xfalse" || test "x$AR" = "x/bin/false"; then
+    AR="" # do not use $AR
+fi
+# protect against security threats caused by misguided compiler "optimizations"
+mandatory_flags="-fno-strict-aliasing -fno-strict-overflow -funsigned-char"
+if test "x$OPTIMIZE" != "x" && test "x$OPTIMIZE" != "x0"; then
+    # not mandatory and not minimal, but usually a good idea:
+    mandatory_flags="-Wall -O2 $mandatory_flags"
+fi
+CC="$CC $mandatory_flags"
+CXX="$CXX $mandatory_flags"
+
+# go to upx top-level directory
+# HINT: set "top_srcdir" manually if your system does not have "readlink"
+if test "x$top_srcdir" = "x"; then
+    my_argv0abs="$(readlink -fn "$my_argv0")"
+    test "x$my_argv0abs" = "x" && exit 1
+    my_argv0dir="$(dirname "$my_argv0abs")"
+    test "x$my_argv0dir" = "x" && exit 1
+    cd "$my_argv0dir/../.." || exit 1
+else
+    cd "$top_srcdir" || exit 1
+fi
+top_srcdir="$(pwd)"             # absolute
+rel_top_srcdir=.                # relative top_srcdir
+echo "# current directory: '$(pwd)'"
+test -f doc/upx.pod   || exit 1 # sanity check
+test -f src/version.h || exit 1 # sanity check
+rm -rf ./build/by-hand          # WARNING: existing build-directory gets deleted!
+
+# helper function
+run() {
+    if test 0 = 1; then
+        # DEBUG dry-run: print command, but don't actually run unless $1 is "+"
+        if test "x$1" = "x+"; then
+            shift; echo "$@"; "$@"; return
+        fi
+        shift; echo "$@"; return
+    fi
+    # print short info and run command
+    test "x$1" != "x" && test "x$1" != "x+" && echo "$1"
+    shift; "$@"
+}
+
+# helper function
+check_submodule() {
+    #local ff # "local" seems unsupported by some versions of ksh
+    for ff in COPYING LICENSE LICENSE.txt; do
+        if test -f "$rel_top_srcdir/vendor/$1/$ff"; then
+            # create and enter build directory; updates global $rel_top_srcdir
+            run "+" cd "$rel_top_srcdir" || exit 1
+            rel_top_srcdir=.
+            echo "#==== build $1 ====="
+            run "+" mkdir "build/by-hand/$1"
+            run "+" cd "build/by-hand/$1" || exit 1
+            rel_top_srcdir=../../..
+            return 0
+        fi
+    done
+    return 1
+}
+
+# build
+run "+" mkdir -p "build/by-hand"
+if check_submodule bzip2; then
+    for f in "$rel_top_srcdir"/vendor/bzip2/*.c; do
+        run "CC  $f" $CC -c "$f"
+    done
+fi
+if check_submodule ucl; then
+    for f in "$rel_top_srcdir"/vendor/ucl/src/*.c; do
+        run "CC  $f" $CC -I"$rel_top_srcdir"/vendor/ucl/include -I"$rel_top_srcdir"/vendor/ucl -c "$f"
+    done
+fi
+if check_submodule zlib; then
+    for f in "$rel_top_srcdir"/vendor/zlib/*.c; do
+        run "CC  $f" $CC -DHAVE_UNISTD_H -DHAVE_VSNPRINTF -c "$f"
+    done
+fi
+if check_submodule zstd; then
+    for f in "$rel_top_srcdir"/vendor/zstd/lib/*/*.c; do
+        run "CC  $f" $CC -DDYNAMIC_BMI2=0 -DZSTD_DISABLE_ASM -c "$f"
+    done
+fi
+run "+" cd "$rel_top_srcdir" || exit 1
+rel_top_srcdir=.
+echo "#==== build UPX ====="
+run "+" cd "build/by-hand" || exit 1
+rel_top_srcdir=../..
+for f in "$rel_top_srcdir"/src/*.cpp "$rel_top_srcdir"/src/*/*.cpp; do
+    run "CXX $f"     $CXX -I"$rel_top_srcdir"/vendor -c "$f"
+done
+# echo "#==== link UPX ====="
+if test "x$AR" = "x"; then
+    # link without using $AR
+    run "CXX upx"    $CXX -o upx *.o */*.o
+else
+    run "AR  libupx" $AR rcs libupx_submodules.a */*.o
+    run "CXX upx"    $CXX -o upx *.o -L. -lupx_submodules
+fi
+echo "# current directory: '$(pwd)'"
+ls -l upx*
+
+echo "# All done."

misc/scripts/check_whitespace.sh

@@ -0,0 +1,39 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+[[ -z $1 ]] || cd "$1" || exit 1
+
+find . \
+    -type d -name '.git' -prune -o \
+    -type d -name '.hg' -prune -o \
+    -type d -name 'build*' -prune -o \
+    -type d -name 'tmp*' -prune -o \
+    -type d -name 'vendor' -prune -o \
+    -type f -iname '*.bat' -prune -o \
+    -type f -iname '*.exe' -prune -o \
+    -type f -iname '*.o' -prune -o \
+    -type f -iname '*.obj' -prune -o \
+    -type f -iname '*.out' -prune -o \
+    -type f -iname '*.pdf' -prune -o \
+    -type f -iname '*.swp' -prune -o \
+    -type f -print0 | \
+LC_ALL=C sort -z | xargs -0r perl -n -e '
+    #print("$ARGV\n");
+    if (m,[\x00\x01\x02\x7f\xfe\xff],) { print "ERROR: binary file detected $ARGV: $_"; exit(1); }
+    if (m,[\r\x1a],) { print "ERROR: DOS EOL detected $ARGV: $_"; exit(1); }
+    if (m,([ \t]+)$,) {
+        # allow exactly two trailing spaces for GitHub flavoured Markdown in .md files
+        if ($1 ne "  " || $ARGV !~ m,\.md$,) {
+            print "ERROR: trailing whitespace detected $ARGV: $_"; exit(1);
+        }
+    }
+    if (m,\t,) {
+       if ($ARGV =~ m,(^|/)(gnu|m)?make(file|vars),i) { }
+       elsif ($ARGV =~ m,/tmp/.*\.(disasm|dump)$,) { }
+       elsif ($ARGV =~ m,/src/stub/src/arch/.*/lzma\w+\.S$,) { }
+       else { print "ERROR: hard TAB detected $ARGV: $_"; exit(1); }
+    }
+' || exit 1

misc/scripts/check_whitespace_git.sh

@@ -0,0 +1,33 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
+
+[[ -z $1 ]] || cd "$1" || exit 1
+[[ -d .git ]] || exit 1
+
+git ls-files --full-name -z | perl -0 -n -e '
+    s,^,./,;
+    if (m,^\./src/lzma-sdk(\0|$),) { }
+    elsif (m,^\./vendor/,) { }
+    elsif (m,\.bat(\0|$),) { }
+    elsif (m,\.exe(\0|$),) { }
+    else { print; }
+' | LC_ALL=C sort -z | xargs -0r perl -n -e '
+    #print("$ARGV\n");
+    if (m,[\x00\x01\x02\x7f\xfe\xff],) { print "ERROR: binary file detected $ARGV: $_"; exit(1); }
+    if (m,[\r\x1a],) { print "ERROR: DOS EOL detected $ARGV: $_"; exit(1); }
+    if (m,([ \t]+)$,) {
+        # allow exactly two trailing spaces for GitHub flavoured Markdown in .md files
+        if ($1 ne "  " || $ARGV !~ m,\.md$,) {
+            print "ERROR: trailing whitespace detected $ARGV: $_"; exit(1);
+        }
+    }
+    if (m,\t,) {
+       if ($ARGV =~ m,(^|/)(gnu|m)?make(file|vars),i) { }
+       elsif ($ARGV =~ m,/tmp/.*\.(disasm|dump)$,) { }
+       elsif ($ARGV =~ m,/src/stub/src/arch/.*/lzma\w+\.S$,) { }
+       else { print "ERROR: hard TAB detected $ARGV: $_"; exit(1); }
+    }
+' || exit 1

misc/scripts/upx-clang-format.sh

@@ -0,0 +1,32 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+
+# "Gofmt's style is nobody's favourite, but gofmt is everybody's favourite." --Rob Pike
+
+# NOTE: we are using clang-format-15.0.6 from upx-stubtools
+# see https://github.com/upx/upx-stubtools/releases
+
+# NOTE: we use .clang-format config from upx.git/.clang-format
+
+if [[ ! -f $UPX_CLANG_FORMAT ]]; then
+UPX_CLANG_FORMAT="$HOME/local/bin/bin-upx/clang-format-15.0.6"
+fi
+if [[ ! -f $UPX_CLANG_FORMAT ]]; then
+UPX_CLANG_FORMAT="$HOME/.local/bin/bin-upx/clang-format-15.0.6"
+fi
+if [[ ! -f $UPX_CLANG_FORMAT ]]; then
+UPX_CLANG_FORMAT="$HOME/bin/bin-upx/clang-format-15.0.6"
+fi
+if [[ ! -f $UPX_CLANG_FORMAT ]]; then
+    echo "ERROR: $0: cannot find clang-format-15.0.6"
+    echo "ERROR: $0: please visit https://github.com/upx/upx-stubtools"
+    exit 1
+fi
+
+# limit memory usage to 1 GiB (in case of clang-format problems with invalid files)
+ulimit -v 1048576 || true
+
+#echo $UPX_CLANG_FORMAT
+exec "$UPX_CLANG_FORMAT" -style=file "$@"
+exit 1

misc/testsuite/upx_testsuite_1-expected_sha256sums.sh

@@ -0,0 +1,209 @@
+########## begin .sha256sums.recreate
+expected_sha256sums__t010_decompressed="\
+24158f78c34c4ef94bb7773a6dda7231d289be76c2f5f60e8b9ddb3f800c100e *amd64-linux.elf/upx-3.91
+24808d572483f4cd713d66894b3da406755038737007a78b076528e6407e3132 *amd64-linux.elf/upx-3.95
+d88eaad0528bcecec9f51cbe015a117c8cf350a3f6d8308f2b0517d4fd19d189 *amd64-win64.pe/upx-3.95.exe
+f7279729eb975e4238f8b8ee56fefa41ccbeb35ef0ffe4c34f8047baab78fff5 *arm-linux.elf/upx-3.95
+e09df2a69f88c692138447f274ba7f99cdd11f8696c71ac8d3761606c95ab5c5 *arm-wince.pe/upx-3.91.exe
+ce81113f8a4ff1cd806811cb80ab8bea5c9c6fbced47451c7f07e50700f9817b *arm64-linux.elf/upx-3.95
+b1c1c38d50007616aaf8e942839648c80a6111023e0b411e5fa7a06c543aeb4a *armeb-linux.elf/upx-3.91
+84b90eb0d617571fe4885639925b35ca6a61060cb2616bb5bf729b4d701653e4 *armeb-linux.elf/upx-3.95
+bcac77a287289301a45fde9a75e4e6c9ad7f8d57856bae6eafaae12ae4445a34 *i386-dos32.djgpp2.coff/upx-3.91.exe
+7d331e508449497f64cd47abdd3f00f70307f508ad3fd692d333feb97beccead *i386-dos32.djgpp2.coff/upx-3.95.exe
+730a513b72a094697f827e4ac1a4f8ef58a614fc7a7ad448fa58d60cd89af7ed *i386-linux.elf/upx-3.91
+a1f3e5ffa7b2cfebe1e475ac1f4c7683b1b8b4e292aa0d04386cc0314dd162c9 *i386-linux.elf/upx-3.95
+e90fb09a808334c2674996760d42c82f8352e3f671f6b66c11481e772785c4d2 *i386-win32.pe/upx-3.91.exe
+07bd50c1d80f6ff651228e6fc0ba3a583a472915772244f232696b34156a9d27 *i386-win32.pe/upx-3.95.exe
+8e5333ea040f5594d3e67d5b09e005d52b3a52ef55099a7c11d7e39ead38e66d *m68k-atari.tos/upx-3.91.ttp
+8902f38ec3d95d8e077e3ab5fdbb5bad408859913a35deb87041f4f053cd6605 *mips-linux.elf/upx-3.95
+c3f44b4d00a87384c03a6f9e7aec809c1addfe3e271244d38a474f296603088c *mipsel-linux.elf/upx-3.91
+dd1496bc4e9c32a5d5dd47e3eaabf7b134ca001d48807eebfd3d5e28c8a2ab58 *mipsel-linux.elf/upx-3.95
+b8c35fa2956da17ca505956e9f5017bb5f3a746322647e24ccb8ff28059cafa4 *powerpc-linux.elf/upx-3.91
+2bc00a51daa0bada19a8fa1bd2c227a8596844fa1b0aa3611087f195072700e2 *powerpc-linux.elf/upx-3.95
+a0950546dc17fca9437219431d8ddb0249ce5b08e899e0c799a87ac982adee70 *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t020_canonicalized="\
+24158f78c34c4ef94bb7773a6dda7231d289be76c2f5f60e8b9ddb3f800c100e *amd64-linux.elf/upx-3.91
+24808d572483f4cd713d66894b3da406755038737007a78b076528e6407e3132 *amd64-linux.elf/upx-3.95
+d88eaad0528bcecec9f51cbe015a117c8cf350a3f6d8308f2b0517d4fd19d189 *amd64-win64.pe/upx-3.95.exe
+f7279729eb975e4238f8b8ee56fefa41ccbeb35ef0ffe4c34f8047baab78fff5 *arm-linux.elf/upx-3.95
+e09df2a69f88c692138447f274ba7f99cdd11f8696c71ac8d3761606c95ab5c5 *arm-wince.pe/upx-3.91.exe
+ce81113f8a4ff1cd806811cb80ab8bea5c9c6fbced47451c7f07e50700f9817b *arm64-linux.elf/upx-3.95
+b1c1c38d50007616aaf8e942839648c80a6111023e0b411e5fa7a06c543aeb4a *armeb-linux.elf/upx-3.91
+84b90eb0d617571fe4885639925b35ca6a61060cb2616bb5bf729b4d701653e4 *armeb-linux.elf/upx-3.95
+bcac77a287289301a45fde9a75e4e6c9ad7f8d57856bae6eafaae12ae4445a34 *i386-dos32.djgpp2.coff/upx-3.91.exe
+7d331e508449497f64cd47abdd3f00f70307f508ad3fd692d333feb97beccead *i386-dos32.djgpp2.coff/upx-3.95.exe
+730a513b72a094697f827e4ac1a4f8ef58a614fc7a7ad448fa58d60cd89af7ed *i386-linux.elf/upx-3.91
+a1f3e5ffa7b2cfebe1e475ac1f4c7683b1b8b4e292aa0d04386cc0314dd162c9 *i386-linux.elf/upx-3.95
+e90fb09a808334c2674996760d42c82f8352e3f671f6b66c11481e772785c4d2 *i386-win32.pe/upx-3.91.exe
+07bd50c1d80f6ff651228e6fc0ba3a583a472915772244f232696b34156a9d27 *i386-win32.pe/upx-3.95.exe
+8e5333ea040f5594d3e67d5b09e005d52b3a52ef55099a7c11d7e39ead38e66d *m68k-atari.tos/upx-3.91.ttp
+8902f38ec3d95d8e077e3ab5fdbb5bad408859913a35deb87041f4f053cd6605 *mips-linux.elf/upx-3.95
+c3f44b4d00a87384c03a6f9e7aec809c1addfe3e271244d38a474f296603088c *mipsel-linux.elf/upx-3.91
+dd1496bc4e9c32a5d5dd47e3eaabf7b134ca001d48807eebfd3d5e28c8a2ab58 *mipsel-linux.elf/upx-3.95
+b8c35fa2956da17ca505956e9f5017bb5f3a746322647e24ccb8ff28059cafa4 *powerpc-linux.elf/upx-3.91
+2bc00a51daa0bada19a8fa1bd2c227a8596844fa1b0aa3611087f195072700e2 *powerpc-linux.elf/upx-3.95
+a0950546dc17fca9437219431d8ddb0249ce5b08e899e0c799a87ac982adee70 *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t110_compress_ucl_nrv2b_3_no_filter="\
+d0b9b8a5bdbbc2f037e7e7b7a9fd2acd7b434ac03d7c59b4f2779c8621eed95e *amd64-linux.elf/upx-3.91
+d36bff9e6f49c93e4c37ab50e109bd6378128017555f8f819080f02235d48d7e *amd64-linux.elf/upx-3.95
+9c312f13ddd40a62fed7ee9f6a21fff15cae7517d4ddf55f493101b22d8e43f1 *amd64-win64.pe/upx-3.95.exe
+b138d38c3955697ee0302332c031c996bacacf5e17eea8fce3282c4ea88f7299 *arm-linux.elf/upx-3.95
+e0436401972603f7fad6c693e96c89c37370113e75b8bdb4d4ecd14dda4cd8fe *arm-wince.pe/upx-3.91.exe
+22107e27f63c5509f5d1c1312cb8ea1e116811695ee7f4deb765f0aa53b25a51 *arm64-linux.elf/upx-3.95
+beae687a0575a65cec981e7cc63fd562d212d7ed64befe5dde2f0b7f92e4838e *armeb-linux.elf/upx-3.91
+55391ffd6bccd2be4e423466d327b9f345371f9941dbb30c003e677b984e8a5e *armeb-linux.elf/upx-3.95
+a467edf8758a5b3e219bc193a9d143cb880f7d1a94771367cda7117129b34cfc *i386-dos32.djgpp2.coff/upx-3.91.exe
+934593ba98f2dfff94197885894e7e56ff452da02a234e70734e2445b27ae8aa *i386-dos32.djgpp2.coff/upx-3.95.exe
+f26697e9a9fceca98b10c1ab6a834fa6b2bd2826a2285deaafe8cd1c754a2f61 *i386-linux.elf/upx-3.91
+f23467fde1af895827e7ad7c46c372802820143620fef2abe657aa8b6e7bdb26 *i386-linux.elf/upx-3.95
+9dd14ff1328b0d501aca10d36623b2b76c754e9677cc0bdd0c5ded740796cecf *i386-win32.pe/upx-3.91.exe
+5320b28b44ae1a50ea435ccabf7fe94c8031be7375c425ed618cb1f9a649442f *i386-win32.pe/upx-3.95.exe
+d30bf134c5231317ae2182059034842f58d906b9dc49546bbb552f4e0411085f *m68k-atari.tos/upx-3.91.ttp
+9d0fca1d248d11ec8e96801dae3978c959a26e372e05836c15b56cfc0b4aa077 *mips-linux.elf/upx-3.95
+d68a073cb1c222515502a3a0e8f91f424cb8cedb0d849d247531c2955fa5399a *mipsel-linux.elf/upx-3.91
+48919a0e564866d59ae1efae06269cea2cf7ebb5e3fda4a9ce70f9f1092a7e59 *mipsel-linux.elf/upx-3.95
+93f04183b21f077d6423c23efee62f0c920cd63463b0932ac6200e966e423763 *powerpc-linux.elf/upx-3.91
+9ef05193c11073f477606ff2c8654f11c370951ff5a7902ba0cab31598751029 *powerpc-linux.elf/upx-3.95
+1c04d45914809449337f22c93bf645703c6c6aa499e789ff9d2dd787be257e96 *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t120_compress_ucl_nrv2d_3_no_filter="\
+89369823c5f2316f00f4a8af2e810a94050e28254669a2a2547a73b166178db2 *amd64-linux.elf/upx-3.91
+a267b53b2de081c414ef82351a5e88431cafdd86f8202e48929d637bf6af9192 *amd64-linux.elf/upx-3.95
+1f40d3e26e266b7c305e01a0e480f936746d1c54df32826f5f6f16fbbe58f20b *amd64-win64.pe/upx-3.95.exe
+3d1ac6e85dfa79f8aa36d2d73073181c5cf7dd6c3e83da3b9248fa990c535d2a *arm-linux.elf/upx-3.95
+856d307362db229387d3d33ad8478a8cba45c71d67d5bbf2d9794154a755722f *arm-wince.pe/upx-3.91.exe
+2fdec54995bf5367991ef64a7582a3a0e3724a71d89e77fdbe8c5bb67071d65e *arm64-linux.elf/upx-3.95
+ddde64e009beff80e2e185b03dbe1b966ffa4c5db18fcd80c409b52233d4bb81 *armeb-linux.elf/upx-3.91
+08aece1b25973a84bedb155c2976ca08e4ce1334e21659e5583f17a0e9e3bc3c *armeb-linux.elf/upx-3.95
+ee07e1e15ff7a467f9ad262daa12886211f107886cae154795651d3cdba6fba3 *i386-dos32.djgpp2.coff/upx-3.91.exe
+f73ac819d5f7f81b7cf62198381a51273df6a697d5429a144f42fabef0bcc327 *i386-dos32.djgpp2.coff/upx-3.95.exe
+3b9e78245b5fa3108d2e69c22764e8204d24089f6661790edbdb88a508923191 *i386-linux.elf/upx-3.91
+6a9aa8025e9389cbbe81a04926d12e120fd57b9909de4ee934e878a04fcf6169 *i386-linux.elf/upx-3.95
+7a667cc2b566ae2f8836cc3c21d55e45bf35d61beca22ec2a806d6bcbfa1f082 *i386-win32.pe/upx-3.91.exe
+cdd58a31c4914bdde47f03d81b988ffc9aa2af482de775c88cae144b4ff04293 *i386-win32.pe/upx-3.95.exe
+02b969917d52c4bd07e49e4ad589db8a1e4fa27984eac2eede03bc1abf73c376 *m68k-atari.tos/upx-3.91.ttp
+722ac1505bdaed421b6cce390608661be7236d4108429853485b8354b3c59347 *mips-linux.elf/upx-3.95
+7309ee902e2c41ae72cc111c185d34e355e3892566e826698780fe69845174ad *mipsel-linux.elf/upx-3.91
+fec12c58da7886a1eaf4702b2b0c710e2b72c4179070b04691b963d1c503c73b *mipsel-linux.elf/upx-3.95
+13ad283bc0e4f37f9f06eddb8c384faa4a2e66e045496aa79dfde0ae59f14a95 *powerpc-linux.elf/upx-3.91
+812550c5b65c39e347648e6ab9d51b2466919205a8b0928ef941ab3160151471 *powerpc-linux.elf/upx-3.95
+0e651fdc257be7b3143ad06559a137be6c87f7b7ec721d1f727dc138465b219d *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t130_compress_ucl_nrv2e_3_no_filter="\
+5ee77141a1fdf1af31f3f9be97e60446873e659e341993a3bbceacb655618aa5 *amd64-linux.elf/upx-3.91
+b94c4603c372400a06c2ae7838ed9f41e6e9393d81e091a0ceed39c861e3443f *amd64-linux.elf/upx-3.95
+c9230d017885d7727ca766cb7933d0681a93ef21856c39fbf807899b734172c0 *amd64-win64.pe/upx-3.95.exe
+6ae717a2a7ebe99f6d1c3af8c83939f5efe2144670806c336640ad88c29a9d90 *arm-linux.elf/upx-3.95
+6dbd0442d9e45c82d113463eb592d117c6761fd073e942342516fb0339d935e7 *arm-wince.pe/upx-3.91.exe
+6f12e95d71382a7960b9712c75a897974f29561d2a8e774b7e984c9fba380aea *arm64-linux.elf/upx-3.95
+94dbeae5763e5c86d865e9c6e473aafdb200b1ed06bfd5981728e0fa5cc6dcc6 *armeb-linux.elf/upx-3.91
+cab852c4a69042aca4337869edce3af5f5aab8bf562a626ab755da0a5517bd73 *armeb-linux.elf/upx-3.95
+dc6d412f41101e334f9e09c52e63f513e2b0bd047064283c0f7389276dd6d28b *i386-dos32.djgpp2.coff/upx-3.91.exe
+0ab8e2454b1f5bfed09a8d0c231f4c595c7445b09077387ebb9348292206be59 *i386-dos32.djgpp2.coff/upx-3.95.exe
+7b6efd3d82b503f4d0ea3a111e80b0a1b785a2766ddea9f4090a7de190f811be *i386-linux.elf/upx-3.91
+c1ede9406344f8b0d5fb08777c31c62016e36f54f3ff69fc03ffbc09d5b40a0e *i386-linux.elf/upx-3.95
+728c6dc0c02d9ea3f7a0c86595fd64423f5545651b3a7bbc9e708759d8eec157 *i386-win32.pe/upx-3.91.exe
+8569f6942377259c5a92acfe5bf0b2874f6ef3af40177947a8055e7641a776ef *i386-win32.pe/upx-3.95.exe
+c4753f47328d70823f85b5d378502556388ee0a9ea6bf100cd6c73651126b3fb *m68k-atari.tos/upx-3.91.ttp
+a918b7825fd5bf50097a62177b4638abee5aeb864e06ce1624042cace8a9a922 *mips-linux.elf/upx-3.95
+4b5cddac9a79b5e7aa99b7589d7e862bfbe026da44c2fed2a1f396883b072442 *mipsel-linux.elf/upx-3.91
+cc1be3f4d27d3ab5f6073f38c47ca72f4ba47121b14b7e60a4906a6d04af4e9c *mipsel-linux.elf/upx-3.95
+cedc2def9464f839e9aab153dfe93dda0d37d0da43e8c600ef366f6adf17b64b *powerpc-linux.elf/upx-3.91
+748a4a2481b73ff2881b6de39749f1672b8b8d7f1d66a6453374caf6d840777d *powerpc-linux.elf/upx-3.95
+f07f45141bf199db4847fd11ff56f496790efc3b7cff248a93c4ca45ca76a71a *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t140_compress_lzma_2_no_filter="\
+f553659c34a772cbdaf571d83d9c8173b75f1e2deecf7c590d38e34b46cab43b *amd64-linux.elf/upx-3.91
+9464896ca0082d41cf7e51159e7cd58a637b0a9d7a9151930e81746f1f43898b *amd64-linux.elf/upx-3.95
+255ef236a7fe03865dd300ce447c57754aef05de537564f38715eef64285c6fa *amd64-win64.pe/upx-3.95.exe
+88ae278afa54ac766f1940f3607c91d4915cdd492988dafac9be274dbda6fd5b *arm-linux.elf/upx-3.95
+14f77ebb33e788aa8f9a9ad608232c3f9047dc6dfd55ceb02244a36cac9aea25 *arm-wince.pe/upx-3.91.exe
+a79b9a7fc7e8a5e0b42fdf342fe44aae827e63809b0797d3deefd4b9f184388c *arm64-linux.elf/upx-3.95
+17603d9f6b48e10b438d65c70e8afbf87a82f84a6ee12e96ac66371663d4f18f *armeb-linux.elf/upx-3.91
+5162fcc6f1327c76c2221d7a5f9668d05dd828f7a6d4dbbc732005d244947805 *armeb-linux.elf/upx-3.95
+3a94cec95fd3eac557bf929b372b20b155e8d331e44e47eb3486b048ebb36c9f *i386-dos32.djgpp2.coff/upx-3.91.exe
+632b63bce916203d52d997d191728667d1091694a5cfc1a2ed327b540357e7e9 *i386-dos32.djgpp2.coff/upx-3.95.exe
+04edc6bc3ec1a4217461ee6b81b0ea29fb25a62721c92ea62ab0dfaa147412b1 *i386-linux.elf/upx-3.91
+36f47959198dace24777e95c3dcff64940ce514dc62b9cb794e957e969f07bae *i386-linux.elf/upx-3.95
+cf3c0f31aca86f30edb45e4bd945997d7acca9c2d54acfc427936fe4ff2ba355 *i386-win32.pe/upx-3.91.exe
+c774fb5e3dcc0a00fa58ce223c30d7805f2f96606d9dddda30075c6a6c35a639 *i386-win32.pe/upx-3.95.exe
+3be124d31c578530d8aa4da4ad53346a6fd62c8d4f3a9b1d068d5f912d9117ee *m68k-atari.tos/upx-3.91.ttp
+0ed619426db38bdbb783e2f47a1ce36c4b6831e00be8626f560cdf968b61f8a1 *mips-linux.elf/upx-3.95
+9b83be53c444ad4dda60b8fa3faf9a7ae4ffb1f99027364a2af52e6c12e64462 *mipsel-linux.elf/upx-3.91
+e405854a04fc1ebf272e57ffc74580e387ce8860ec460d77e660c829d30d9153 *mipsel-linux.elf/upx-3.95
+f876a78a55939bf5ec990aaa3ece0a8a69d0a70eb7b00422d44ee1f0fa9ec6ea *powerpc-linux.elf/upx-3.91
+8e65ca7e13e26b18c5ee93ab2c1a06f244dd7fff72da4523de3225feed9a4002 *powerpc-linux.elf/upx-3.95
+07c6d83eeb6c664674df125fa9711c76140ccec562022f8d1334c761c00e787e *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t150_compress_ucl_2_all_filters="\
+c41d2eb5d32c57b1302ceb17bb18b3cf7f611f8e31478f47e188cc39870b0e8d *amd64-linux.elf/upx-3.91
+0dd8f6812aed9accea975c855dc2b4ae48fa2d03554614484de1d0335364e370 *amd64-linux.elf/upx-3.95
+8cf83b49aab1a366318591fe69d87408ec1f7b36c3470a9cee82fd1fc39d7899 *amd64-win64.pe/upx-3.95.exe
+b4b25da30e8f5da864bd8319d1c9b193eff9cf20f365d768763a2972a02d4c0f *arm-linux.elf/upx-3.95
+040117965a54878b7665b7f8155230e0f171a7749c961a1dca26eb76719b3b97 *arm-wince.pe/upx-3.91.exe
+2b790cb0fe0b83ade980b1014e4b2f9336557f4f3ae469b94a32757ea88a281c *arm64-linux.elf/upx-3.95
+aa7ad6e9b537ab8a17d4bee539d220b39ec0fded7e9924178e3be786c6cc6907 *armeb-linux.elf/upx-3.91
+66b161bdb4f9c94518f04acb385ddcaa180913f62bafc060d9f723f2bde40bdb *armeb-linux.elf/upx-3.95
+1584cbffe0037e9e3c441aeac8fc2ef226ee78d0430d4298070c7258a5de650e *i386-dos32.djgpp2.coff/upx-3.91.exe
+da37d160c4c185dfb7c0754637278a512503ecc396741678adfda38423eaae44 *i386-dos32.djgpp2.coff/upx-3.95.exe
+39d8526dfd19d6fa8753731dc4dd362ede4a360f834f41f7d320f3e5ac1aa083 *i386-linux.elf/upx-3.91
+3a86c29348f68ec5b99dad6b739a66c36f64bf35adcc7defa950e3140c99e11d *i386-linux.elf/upx-3.95
+6cc7deccbafc7c5a658a017ca18613b004d3b9b21e2a4e08343f92fbb82587fb *i386-win32.pe/upx-3.91.exe
+43c04b1eef6ea89821dc8689f09865008784fcb2152cbc59a3be7c091a56a536 *i386-win32.pe/upx-3.95.exe
+d0ccb6fa3cb2557923c494a5d41615e2ba6687960144a98ae575761d20ff29d6 *m68k-atari.tos/upx-3.91.ttp
+9a217e5a233b523a1d031819f8e9acb00d5be03e8e8b718dc18a8819b5b04a3a *mips-linux.elf/upx-3.95
+a5e18b41cad43cc4583cbb49248c3608d64df760a8deb302aaed5f96d3f9a46b *mipsel-linux.elf/upx-3.91
+b799dbcfc4fde1cdfa572a0143a4513d83636ea0883eec320761ae57a7c36ccd *mipsel-linux.elf/upx-3.95
+ce42a8aad4bbed730e7bcd7970efa170040eef22c9ecad4a993b81d2f6780329 *powerpc-linux.elf/upx-3.91
+6c812174a92107ac598a6b36b2e14cad82109813e14c436a2aa9d517bdea107b *powerpc-linux.elf/upx-3.95
+047a4063962c372bce50aed451404d06e3f00a4f8a535acf0f92895ebc47ba0a *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t160_compress_all_methods_1_no_filter="\
+848eff62a732dce17b36fa34277727cdbe68637dd169c0d4fa831a8085369c6c *amd64-linux.elf/upx-3.91
+9a7a1df07d95f17b64a9c714a444b61baf790a3a3378b53c1f0f7752c5ef7aa3 *amd64-linux.elf/upx-3.95
+ff5f4d665a04bfa1bddabf9853686626aea828a8e542006ef7d76d49b549d9d5 *amd64-win64.pe/upx-3.95.exe
+a1f0f5df99eeed2009cdf2d253c824335b7010d91458297718bd257a2c2bc464 *arm-linux.elf/upx-3.95
+8b236855f4df2df1072a93d3bd1f7203c3d43801830a38679afc354250c6a7be *arm-wince.pe/upx-3.91.exe
+e0644a18614e3ff48c3a8c306ab0c057a3ef58fab7015e522a6ef7a9aeb28970 *arm64-linux.elf/upx-3.95
+bffe4754c49568fcc9cf67e973ecb9a48e8119bab4b03d9ebae436192fbfe76b *armeb-linux.elf/upx-3.91
+e69f6fc17db59b12c6910af45704c33387079492c24b1659038433e4211a8898 *armeb-linux.elf/upx-3.95
+14133daa854c4355b25e58803ad9b5e4bfb5e665fdbf12489f8b7c29ef6646a3 *i386-dos32.djgpp2.coff/upx-3.91.exe
+1a903afd11b866820a1814c6ee8a68431727e5c570045169295a425a6198a273 *i386-dos32.djgpp2.coff/upx-3.95.exe
+86a466a5d4568b225216cce95738fc63457b065b36590ca4d204108768ca8f78 *i386-linux.elf/upx-3.91
+79077dc8b999ee25171ee721e8ca56880c6d0b486f88747861ef437370075504 *i386-linux.elf/upx-3.95
+58b93bd7d162f89c2ea187590c515192649831ab94435b87b27d47a9e74379e4 *i386-win32.pe/upx-3.91.exe
+34c4260a53579a6859668cf3eb6c069cf5db82c00ad605bfdc8b2f1e0450aa16 *i386-win32.pe/upx-3.95.exe
+8495d281bf4a8f193a204b5a56d49b3c645370049e8e83db4154db3e02d55543 *m68k-atari.tos/upx-3.91.ttp
+388b013a17b84b1068502fb01b13a78a17bec5f1bd7953ec127ee3c952a7da1c *mips-linux.elf/upx-3.95
+466da371ef3123d18c61e2a094d7a609e16dd005f0ea8a46d813690405e1d616 *mipsel-linux.elf/upx-3.91
+36bed2f441c3abc918b46cfb80ff1bd31c82b264c3f69dcf0c1c28521fd53128 *mipsel-linux.elf/upx-3.95
+0b988e12ea324ce2c6ba9506209bbb80c10bb6a02ff8949887e810f44d710338 *powerpc-linux.elf/upx-3.91
+94981cf2f48631c476da88f8e5dcecf3ee68772ce12b189d33aaf871ef7a9536 *powerpc-linux.elf/upx-3.95
+616a829f2d1324fad2863481a5cba088f2a51c38de866c20fe9d9d7a75df3dfc *powerpc64le-linux.elf/upx-3.95
+"
+expected_sha256sums__t170_compress_all_methods_no_lzma_5_no_filter="\
+55046a0c623116f9d6c78e62d7f3fb781e3aa8d8a03e987f49f0705ee3a7840b *amd64-linux.elf/upx-3.91
+a9ca57293b43b093fb9582a81a2ad2877f7c2546a536541bf3766452a9faa4aa *amd64-linux.elf/upx-3.95
+3247a637f6cc56219bc2d6a3b16237226e1ba97ac1d0fce012657e23bfe256c3 *amd64-win64.pe/upx-3.95.exe
+d43683421216236ab6e90f4f7d6ad69f3b1d18e53bc5dd57b5dcea2916fe480f *arm-linux.elf/upx-3.95
+387787098a33b61637b39d7d015972d18e687771d8596b74286764ac73ee9286 *arm-wince.pe/upx-3.91.exe
+e2e476b9ccfd13f14940f28240b8e6f85ce0e21f6cc5b619cc2972b9238b5bd2 *arm64-linux.elf/upx-3.95
+538eef066d7deb4b6c07de4a50ffaf24a759278beeee9204e4d6c642aa382de3 *armeb-linux.elf/upx-3.91
+9349eca3e551ce1d2ab95735b8898efc54439c3d87395f2c0bddbe88fbc35cbc *armeb-linux.elf/upx-3.95
+ce768b3be6ffeb84d0558a937a9a5778427ce56898a9b3ef9490e7e5ba6ce688 *i386-dos32.djgpp2.coff/upx-3.91.exe
+849e285cb39e5609f384559398c47f5e34d2067711c58aacc5ed1c97495b8da0 *i386-dos32.djgpp2.coff/upx-3.95.exe
+6a0b78c2af8d68faac587531b32679a3a264fa86f524cf801db31a41a231becb *i386-linux.elf/upx-3.91
+e524ee0c3058ba4a44073ec29d67982bc39721865b33e6881dffbe2329a79279 *i386-linux.elf/upx-3.95
+06d281a60d5ed815f74052e3e133915739e58c3a563a2e914186e85114687a12 *i386-win32.pe/upx-3.91.exe
+a1c3256670c4f55d3aea58063c4689d122c605d079537a27b1952eeab8d5d6ad *i386-win32.pe/upx-3.95.exe
+b866f184c6fe911b410afa8080acd1c7fddc11131d15bd272eb8adbca20439d2 *m68k-atari.tos/upx-3.91.ttp
+197d7dace27bbeba5627868b7a333b4580673ffe38353f3a11bd2d65b4216470 *mips-linux.elf/upx-3.95
+9b13d57d59a97313e20a0d3e02641045fddd5eb3bcbbcf7772181d5d87c4b3bf *mipsel-linux.elf/upx-3.91
+6f671511e19d9719c0bc7c2344d65cbf13a04da1c9bae9e55d2ca83ba9dede0a *mipsel-linux.elf/upx-3.95
+4ec415399f04f546d9831758a3cfedb00f20b06cb7e1c2eb38354aff3b6d3004 *powerpc-linux.elf/upx-3.91
+20e31a1df4eb5f6a930b34707b591265c6b5609ee2b2cdd5f504009284d1afc9 *powerpc-linux.elf/upx-3.95
+fe4dd9c59e6ae76ff23d6b4df27ca0df4289f6d13c8e3dc8d82c22982639ddd9 *powerpc64le-linux.elf/upx-3.95
+"
+########## end .sha256sums.recreate

misc/testsuite/upx_testsuite_1.sh

@@ -0,0 +1,329 @@
+#! /usr/bin/env bash
+## vim:set ts=4 sw=4 et:
+set -e; set -o pipefail
+argv0=$0; argv0abs=$(readlink -fn "$argv0"); argv0dir=$(dirname "$argv0abs")
+
+# very first version of the upx-testsuite; requires:
+#   $upx_exe                (required, but with convenience fallback "./upx")
+#   $upx_testsuite_SRCDIR   (required, but with convenience fallback)
+#   $upx_testsuite_BUILDDIR (optional)
+#
+# optional settings:
+#   $upx_exe_runner         (e.g. "qemu-x86_64 -cpu Westmere" or "valgrind")
+#   $UPX_TESTSUITE_VERBOSE
+#   $UPX_TESTSUITE_LEVEL
+#
+# see https://github.com/upx/upx-testsuite.git
+
+# /***********************************************************************
+# // init & checks
+# ************************************************************************/
+
+# upx_exe
+[[ -z $upx_exe && -f ./upx && -x ./upx ]] && upx_exe=./upx # convenience fallback
+if [[ -z $upx_exe ]]; then echo "UPX-ERROR: please set \$upx_exe"; exit 1; fi
+if [[ ! -f $upx_exe ]]; then echo "UPX-ERROR: file '$upx_exe' does not exist"; exit 1; fi
+upx_exe=$(readlink -fn "$upx_exe") # make absolute
+[[ -f $upx_exe ]] || exit 1
+upx_run=()
+if [[ -n $upx_exe_runner ]]; then
+    # usage examples:
+    #   export upx_exe_runner="qemu-x86_64 -cpu Westmere"
+    #   export upx_exe_runner="valgrind --leak-check=no --error-exitcode=1 --quiet"
+    #   export upx_exe_runner="wine"
+    IFS=' ' read -r -a upx_run <<< "$upx_exe_runner" # split at spaces into array
+fi
+upx_run+=( "$upx_exe" )
+echo "upx_run='${upx_run[*]}'"
+
+# upx_run check, part1
+if ! "${upx_run[@]}" --version-short >/dev/null; then echo "UPX-ERROR: FATAL: upx --version-short FAILED"; exit 1; fi
+if ! "${upx_run[@]}" -L >/dev/null 2>&1; then echo "UPX-ERROR: FATAL: upx -L FAILED"; exit 1; fi
+if ! "${upx_run[@]}" --help >/dev/null;  then echo "UPX-ERROR: FATAL: upx --help FAILED"; exit 1; fi
+
+# upx_testsuite_SRCDIR
+if [[ -z $upx_testsuite_SRCDIR ]]; then
+    # convenience fallback: search standard locations below upx top-level directory
+    if [[                 -d "$argv0dir/../../../upx--upx-testsuite.git/files/packed" ]]; then
+        upx_testsuite_SRCDIR="$argv0dir/../../../upx--upx-testsuite.git"
+    elif [[               -d "$argv0dir/../../../upx-testsuite.git/files/packed" ]]; then
+        upx_testsuite_SRCDIR="$argv0dir/../../../upx-testsuite.git"
+    elif [[               -d "$argv0dir/../../../upx-testsuite/files/packed" ]]; then
+        upx_testsuite_SRCDIR="$argv0dir/../../../upx-testsuite"
+    fi
+fi
+if [[ ! -d "$upx_testsuite_SRCDIR/files/packed" ]]; then
+    echo "invalid or missing \$upx_testsuite_SRCDIR:"
+    echo "  please git clone https://github.com/upx/upx-testsuite.git"
+    echo "  and set (export) the envvar upx_testsuite_SRCDIR to the local file path"
+    exit 1
+fi
+upx_testsuite_SRCDIR=$(readlink -fn "$upx_testsuite_SRCDIR") # make absolute
+[[ -d $upx_testsuite_SRCDIR ]] || exit 1
+
+# upx_testsuite_BUILDDIR
+if [[ -z $upx_testsuite_BUILDDIR ]]; then
+    upx_testsuite_BUILDDIR="./tmp-upx-testsuite"
+fi
+mkdir -p "$upx_testsuite_BUILDDIR" || exit 1
+upx_testsuite_BUILDDIR=$(readlink -fn "$upx_testsuite_BUILDDIR") # make absolute
+[[ -d $upx_testsuite_BUILDDIR ]] || exit 1
+
+cd / && cd "$upx_testsuite_BUILDDIR" || exit 1
+: > ./.mfxnobackup
+
+# upx_run check, part2
+if ! "${upx_run[@]}" --version-short >/dev/null; then
+    echo "UPX-ERROR: FATAL: upx --version-short FAILED"
+    echo "please make sure that \$upx_exe contains ABSOLUTE file paths and can be run from any directory"
+    echo "INFO: upx_run='${upx_run[*]}'"
+    exit 1
+fi
+if ! "${upx_run[@]}" -L >/dev/null 2>&1; then echo "UPX-ERROR: FATAL: upx -L FAILED"; exit 1; fi
+if ! "${upx_run[@]}" --help >/dev/null;  then echo "UPX-ERROR: FATAL: upx --help FAILED"; exit 1; fi
+
+case $UPX_TESTSUITE_LEVEL in
+    [0-8]) ;;
+    *) UPX_TESTSUITE_LEVEL=999 ;;
+esac
+if [[ $UPX_TESTSUITE_LEVEL == 0 ]]; then
+    echo "UPX testsuite SKIPPED."
+    exit 0
+fi
+
+# /***********************************************************************
+# // setup
+# ************************************************************************/
+
+#set -x # debug
+exit_code=0
+num_errors=0
+all_errors=
+
+export UPX="--prefer-ucl --no-color --no-progress"
+export UPX_DEBUG_DISABLE_GITREV_WARNING=1
+export UPX_DEBUG_DOCTEST_VERBOSE=0
+
+rm -rf ./testsuite_1
+mkdir testsuite_1 || exit 1
+cd testsuite_1 || exit 1
+
+# /***********************************************************************
+# // support functions
+# ************************************************************************/
+
+run_upx() {
+    local ec=0
+    if [[ $UPX_TESTSUITE_VERBOSE == 1 ]]; then
+        echo "LOG: '${upx_run[*]}' $*"
+    fi
+    "${upx_run[@]}" "$@" || ec=$?
+    if [[ $ec != 0 ]]; then
+        echo "FATAL: '${upx_run[*]}' $*"
+        echo "  (exit code was $ec)"
+        exit 42
+    fi
+}
+
+testsuite_header() {
+    local x='==========='; x="$x$x$x$x$x$x$x"
+    echo -e "\n${x}\n${1}\n${x}\n"
+}
+
+testsuite_split_f() {
+    fd=$(dirname "$1")
+    fb=$(basename "$1")
+    fsubdir=$(basename "$fd")
+    # sanity checks
+    if [[ ! -f $1 || -z $fsubdir || -z $fb ]]; then
+        fd=''; fb=''; fsubdir=''
+    fi
+}
+
+testsuite_check_sha() {
+    (cd "$1" && sha256sum -b [0-9a-zA-Z]*/* | LC_ALL=C sort -k2) > $1/.sha256sums.current
+    echo
+    cat $1/.sha256sums.current
+    if ! cmp -s $1/.sha256sums.expected $1/.sha256sums.current; then
+        echo "UPX-ERROR: $1 FAILED: checksum mismatch"
+        diff -u $1/.sha256sums.expected $1/.sha256sums.current || true
+        exit_code=99
+        let num_errors+=1 || true
+        all_errors="${all_errors} $1"
+        #exit 99
+    fi
+    echo
+}
+
+testsuite_check_sha_decompressed() {
+    (cd "$1" && sha256sum -b [0-9a-zA-Z]*/* | LC_ALL=C sort -k2) > $1/.sha256sums.current
+    if ! cmp -s $1/.sha256sums.expected $1/.sha256sums.current; then
+        cat $1/.sha256sums.current
+        echo "UPX-ERROR: FATAL: $1 FAILED: decompressed checksum mismatch"
+        diff -u $1/.sha256sums.expected $1/.sha256sums.current || true
+        exit 98
+    fi
+}
+
+testsuite_use_canonicalized=1
+testsuite_run_compress() {
+    testsuite_header $testdir
+    local files f
+    if [[ $testsuite_use_canonicalized == 1 ]]; then
+        files='t020_canonicalized/*/*'
+    else
+        files='t010_decompressed/*/*'
+    fi
+    for f in $files; do
+        testsuite_split_f "$f"
+        [[ -z $fb ]] && continue
+        echo "# $f"
+        mkdir -p "$testdir/$fsubdir" "$testdir/.decompressed/$fsubdir"
+        run_upx -qq --prefer-ucl "$@" "$f" -o "$testdir/$fsubdir/$fb"
+        run_upx -qq -d "$testdir/$fsubdir/$fb" -o "$testdir/.decompressed/$fsubdir/$fb"
+    done
+    testsuite_check_sha $testdir
+    run_upx -qq -l "$testdir"/*/*
+    run_upx -qq --file-info "$testdir"/*/*
+    run_upx -q -t "$testdir"/*/*
+    if [[ $testsuite_use_canonicalized == 1 ]]; then
+        # check that after decompression the file matches the canonicalized version
+        cp t020_canonicalized/.sha256sums.expected $testdir/.decompressed/
+        testsuite_check_sha_decompressed $testdir/.decompressed
+        rm -rf "./$testdir/.decompressed"
+    fi
+}
+
+# /***********************************************************************
+# // expected checksums
+# //
+# // To ease maintenance of this script in case of updates this section
+# // can be automatically re-created from the current checksums -
+# // see call of function recreate_expected_sha256sums below.
+# ************************************************************************/
+
+recreate_expected_sha256sums() {
+    local o="$1"
+    local files f d
+    echo "########## begin .sha256sums.recreate" > "$o"
+    files='*/.sha256sums.current'
+    for f in $files; do
+        d=$(dirname "$f")
+        echo "expected_sha256sums__${d}="'"\' >> "$o"
+        cat "$f" >> "$o"
+        echo '"' >> "$o"
+    done
+    echo "########## end .sha256sums.recreate" >> "$o"
+}
+
+source "$argv0dir/upx_testsuite_1-expected_sha256sums.sh" || exit 1
+
+# /***********************************************************************
+# // decompression tests
+# ************************************************************************/
+
+testdir=t010_decompressed
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+
+testsuite_header $testdir
+for f in "$upx_testsuite_SRCDIR"/files/packed/*/upx-3.9[15]*; do
+    testsuite_split_f "$f"
+    [[ -z $fb ]] && continue
+    echo "# $f"
+    mkdir -p "$testdir/$fsubdir"
+    run_upx -qq -d "$f" -o "$testdir/$fsubdir/$fb"
+done
+testsuite_check_sha $testdir
+
+# run one pack+unpack step to canonicalize the files
+testdir=t020_canonicalized
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+
+testsuite_header $testdir
+for f in t010_decompressed/*/*; do
+    testsuite_split_f "$f"
+    [[ -z $fb ]] && continue
+    echo "# $f"
+    mkdir -p "$testdir/$fsubdir/.packed"
+    run_upx -qq --prefer-ucl -1 "$f" -o "$testdir/$fsubdir/.packed/$fb"
+    run_upx -qq -d "$testdir/$fsubdir/.packed/$fb" -o "$testdir/$fsubdir/$fb"
+done
+testsuite_check_sha $testdir
+
+# /***********************************************************************
+# // compression tests
+# // info: we use fast compression levels because we want to
+# //   test UPX and not the compression libraries
+# ************************************************************************/
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 2 ]]; then
+testdir=t110_compress_ucl_nrv2b_3_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --nrv2b -3 --no-filter
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 3 ]]; then
+testdir=t120_compress_ucl_nrv2d_3_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --nrv2d -3 --no-filter
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 4 ]]; then
+testdir=t130_compress_ucl_nrv2e_3_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --nrv2e -3 --no-filter
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 5 ]]; then
+testdir=t140_compress_lzma_2_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --lzma -2 --no-filter
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 6 ]]; then
+testdir=t150_compress_ucl_2_all_filters
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress -2 --all-filters
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 7 ]]; then
+testdir=t160_compress_all_methods_1_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --all-methods -1 --no-filter
+fi
+
+if [[ $UPX_TESTSUITE_LEVEL -ge 8 ]]; then
+testdir=t170_compress_all_methods_no_lzma_5_no_filter
+mkdir $testdir; v=expected_sha256sums__$testdir; echo -n "${!v}" >$testdir/.sha256sums.expected
+time testsuite_run_compress --all-methods --no-lzma -5 --no-filter
+fi
+
+# /***********************************************************************
+# // summary
+# ************************************************************************/
+
+# recreate checksums from current version for an easy update in case of changes
+recreate_expected_sha256sums .sha256sums.recreate
+
+testsuite_header "UPX testsuite summary: level $UPX_TESTSUITE_LEVEL"
+run_upx --version-short
+echo
+echo "upx_exe='$upx_exe'"
+ls -l "$upx_exe"
+if command -v file >/dev/null; then
+    file "$upx_exe" || true
+fi
+echo "upx_run='${upx_run[*]}'"
+echo "upx_testsuite_SRCDIR='$upx_testsuite_SRCDIR'"
+echo "upx_testsuite_BUILDDIR='$upx_testsuite_BUILDDIR'"
+echo ".sha256sums.{expected,current} counts:"
+cat ./*/.sha256sums.expected | LC_ALL=C sort | wc
+cat ./*/.sha256sums.current  | LC_ALL=C sort | wc
+echo
+if [[ $exit_code == 0 ]]; then
+    echo "UPX testsuite passed. All done."
+else
+    echo "UPX-ERROR: UPX testsuite FAILED:${all_errors}"
+    echo "UPX-ERROR: UPX testsuite FAILED with $num_errors error(s). See log file."
+fi
+exit $exit_code

patches/patch-elfcode.h

@@ -1,101 +0,0 @@
-The GNU bfd binary file descriptor package, part of the GNU binutils package,
-contains code to recognize an Elf file by looking at fields in the file header.
-Many programs (such as gdb, size, objdump, objcopy, strip and others) use bfd.
-Unfortunately, bfd has been overly strict.  In releases
-   binutils-2.9.1.0.4, binutils-2.9.1.0.23, binutils-2.9.5.0.0,
-   binutils-2.10.1,
-   gdb-4.17, gdb-5.0,
-and probably others,
-bfd does not recognize a file with zero in Elf32_Ehdr.e_shoff, .e_shentsize,
-or .e_shnum, even though the operating system kernel does not care, and many
-bfd clients would work just fine in these cases.
-
-Because of its desire to create small size compressed executables, UPX
-generates and uses Elf files with zero in .e_shoff, .e_shentsizes, and .e_shnum.
-As a result, many widely-distributed instances of gdb, size, objdump, etc.,
-refuse to work on UPX-packed executables.
-
-Here is a patch to bfd/elfcode.h which enables many bfd clients to work
-with UPX-packed executables.  The last two lines of the patch are
-       if (bfd_seek (abfd, hdr->sh_offset, SEEK_SET) == -1)
- 	return -1;
-
-
---- elfcode.h.orig	Mon Jun 16 11:45:32 1997
-+++ elfcode.h	Sat Apr 22 10:18:56 2000
-@@ -1,5 +1,5 @@
- /* ELF executable support for BFD.
--   Copyright 1991, 92, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
-+   Copyright 1991, 92, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
- 
-    Written by Fred Fish @ Cygnus Support, from information published
-    in "UNIX System V Release 4, Programmers Guide: ANSI C and
-@@ -517,14 +517,14 @@
-   elf_debug_file (i_ehdrp);
- #endif
- 
--  /* If there is no section header table, we're hosed. */
--  if (i_ehdrp->e_shoff == 0)
-+  /* If there is no section header table, and relocatable, then we're hosed. */
-+  if (i_ehdrp->e_shoff == 0 && i_ehdrp->e_type == ET_REL)
-     goto got_wrong_format_error;
- 
-   /* As a simple sanity check, verify that the what BFD thinks is the
-      size of each section header table entry actually matches the size
--     recorded in the file. */
--  if (i_ehdrp->e_shentsize != sizeof (x_shdr))
-+     recorded in the file, but only if there are any sections. */
-+  if (i_ehdrp->e_shentsize != sizeof (x_shdr) &&  i_ehdrp->e_shnum != 0)
-     goto got_wrong_format_error;
- 
-   ebd = get_elf_backend_data (abfd);
-@@ -579,6 +579,7 @@
-   /* Allocate space for a copy of the section header table in
-      internal form, seek to the section header table in the file,
-      read it in, and convert it to internal form.  */
-+ if (i_ehdrp->e_shnum!=0) {
-   i_shdrp = ((Elf_Internal_Shdr *)
- 	     bfd_alloc (abfd, sizeof (*i_shdrp) * i_ehdrp->e_shnum));
-   elf_elfsections (abfd) = ((Elf_Internal_Shdr **)
-@@ -609,6 +610,7 @@
-       if (! bfd_section_from_shdr (abfd, i_ehdrp->e_shstrndx))
- 	goto got_no_match;
-     }
-+ }
- 
-   /* Read in the program headers.  */
-   if (i_ehdrp->e_phnum == 0)
-@@ -644,6 +646,7 @@
-      bfd_section_from_shdr with it (since this particular strtab is
-      used to find all of the ELF section names.) */
- 
-+ if (i_ehdrp->e_shstrndx != 0) {
-   shstrtab = bfd_elf_get_str_section (abfd, i_ehdrp->e_shstrndx);
-   if (!shstrtab)
-     goto got_no_match;
-@@ -657,6 +660,7 @@
-       if (! bfd_section_from_shdr (abfd, shindex))
- 	goto got_no_match;
-     }
-+ }
- 
-   /* Let the backend double check the format and override global
-      information.  */
-@@ -930,7 +934,7 @@
- {
-   Elf_Internal_Shdr *hdr;
-   Elf_Internal_Shdr *verhdr;
--  long symcount;		/* Number of external ELF symbols */
-+  unsigned long symcount;	/* Number of external ELF symbols */
-   elf_symbol_type *sym;		/* Pointer to current bfd symbol */
-   elf_symbol_type *symbase;	/* Buffer for generated bfd symbols */
-   Elf_Internal_Sym i_sym;
-@@ -978,7 +982,7 @@
-     sym = symbase = NULL;
-   else
-     {
--      long i;
-+      unsigned long i;
- 
-       if (bfd_seek (abfd, hdr->sh_offset, SEEK_SET) == -1)
- 	return -1;

src/.cvsignore

@@ -1,12 +0,0 @@
-*.0??
-*.idb
-*.map
-*.pdb
-*.upx
-.gdbinit
-.Attic
-upx
-upx_nrv
-upx_nrv.*
-upx_ucl
-upx_ucl.*

src/Makefile

@@ -1,482 +1,110 @@
-# UPX Makefile (GNU make) - works with djgpp2/win32/unix
 #
-# usage:
-#   `make target=linux'         # linux
-#   `make target=djggp2'        # djggp2 2.03
-#   `make target=cygwin'        # cygwin 1.1.x
-#   `make target=mingw32'       # mingw32
-#   `make target=no-cygwin'     # mingw32 as included in cygwin 1.1.x
-#   `make target=vc6'           # Visual C++ 6.0
+# UPX src Makefile - needs GNU make and CMake >= 3.13
+# Copyright (C) Markus Franz Xaver Johannes Oberhumer
 #
 
+# NOTE: this Makefile is deprecated - please directly use the CMake build
+# instead. And see the top-level Makefile for some pre-defined CMake
+# build configurations.
 
-# configuration section
+MAKEFLAGS += -r
+export SHELL = /bin/sh
 
-ifeq ($(strip $(UCLDIR)),)
-# change this to reflect where the UCL library is
-UCLDIR = $(HOME)/local/src/ucl-0.92
+ifndef srcdir
+  srcdir := $(dir $(lastword $(MAKEFILE_LIST)))
+  srcdir := $(shell echo '$(srcdir)' | sed 's,/*$$,,' || echo 'ERROR')
+endif
+ifndef top_srcdir
+  top_srcdir := $(srcdir)/..
 endif
 
-DEBUG = 0
+#
+# redirect to top-level CMake build
+#
 
+# NOTE that top-level Makefile .DEFAULT_GOAL is build/release
+.DEFAULT_GOAL = build/debug
 
-# -------------------------------------------------------
-# You should not have to change anything below this line.
-# -------------------------------------------------------
-
-SHELL = /bin/sh
+build/debug:   $(top_srcdir)/build/debug/upx
+build/release: $(top_srcdir)/build/release/upx
+# shortcuts
+all: build/debug build/release
+debug: build/debug
+release: build/release
 
+$(top_srcdir)/build/debug/upx: PHONY
+	$(MAKE) -C $(top_srcdir) build/debug
+$(top_srcdir)/build/release/upx: PHONY
+	$(MAKE) -C $(top_srcdir) build/release
 
+.NOTPARALLEL: # because the actual builds use "cmake --parallel"
+.PHONY: PHONY
+.SECONDEXPANSION:
 .SUFFIXES:
-.SUFFIXES: .a .c .cpp .exe .lib .o .obj
 
+#
+# "make run-testsuite"
+# see https://github.com/upx/upx-testsuite.git
+#
 
-srcdir = .
-top_srcdir = ..
-
-
-# auto-detect the target unless given on the commandline
-target = djgpp2
-ifneq ($(strip $(wildcard /usr/include/linux)),)
-target = linux
-endif
-ifneq ($(strip $(wildcard /platform/sun4?/kernel/unix)),)
-target = sparc
-endif
-ifeq ($(target),msc)
-override target = vc6
-endif
-
-
-# util var for use in the rules - basename of the current target
-override T = $(basename $@)
-
-
-# /***********************************************************************
-# // object files
-# ************************************************************************/
-
-# these use exceptions & RTTI
-OBJECTS1 = \
-	compress$o except$o file$o lefile$o \
-	filter$o mem$o msg$o stdcxx$o work$o ui$o \
-	packer$o packhead$o packmast$o \
-	p_com$o p_djgpp2$o p_exe$o p_lx_elf$o p_lx_sep$o p_lx_sh$o \
-	p_sys$o p_tmt$o p_tos$o \
-	p_unix$o p_vmlinz$o p_w32pe$o p_wcle$o
-
-# no exceptions or RTTI
-OBJECTS2 = \
-	filteri$o help$o main$o mygetopt$o util$o linker$o \
-	c_init$o c_file$o c_none$o c_screen$o \
-	s_object$o s_djgpp2$o s_vcsa$o s_win32$o
-
-# pure C sources
-OBJECTS3 =
-
-OBJECTS = $(OBJECTS1) $(OBJECTS2) $(OBJECTS3)
-
-
-# /***********************************************************************
-# // compiler settings
-# ************************************************************************/
-
-# default to a gcc unix-type compiler
-CC = gcc
-CXX = $(CC)
-DEFS =
-INCLUDES = -I$(srcdir)
-CFLAGS_OUTPUT = -o $@
-CXXFLAGS_OUTPUT = $(CFLAGS_OUTPUT)
-
-LINK_EXE = $(CC) $(LDFLAGS) $(EXTRA_LDFLAGS) -o $@ $^ $(LDLIBS)
-STUBEDIT_EXE =
-
-o = .o
-a = .a
-e = .exe
-
-
-###
-### gcc defaults
-###
-
-##CFLAGS_O  = -Os
-CFLAGS_O  = -O2
-##CFLAGS_WERROR = -Werror
-CFLAGS_W  = $(CFLAGS_WERROR)
-CFLAGS_W += -Wall -W -Wcast-align -Wcast-qual -Wmissing-declarations -Wmissing-prototypes -Wshadow -Wwrite-strings
-##CFLAGS_M  = -fno-builtin
-## CFLAGS_M += -malign-functions=0 -malign-jumps=0 -malign-loops=0
-
-CFLAGS    = $(CFLAGS_W) $(CFLAGS_O) $(CFLAGS_M)
-CXXFLAGS  = $(CFLAGS) -Wsynth -fconserve-space
-CXXFLAGS1 = $(CXXFLAGS)
-CXXFLAGS2 = $(CXXFLAGS) -fno-exceptions -fno-rtti
-
-ifeq ($(DEBUG),1)
-DEFS += -DDEBUG
-## DEFS += -DTESTING
-endif
-
-ifeq ($(DEBUG),1)
-LDFLAGS = -g
-else
-LDFLAGS = -s
-endif
-LDFLAGS += -Wl,-Map,$T.map
-LDLIBS =
-LDLIBS = -lz
-LIBDIRS =
-DOS_LIBDIRS =
-
-
-###
-### compression library
-###
-
-UCLDIR:=$(strip $(subst \,/,$(UCLDIR)))
-NRVDIR:=$(strip $(subst \,/,$(NRVDIR)))
-u = ucl
-U = UCL
-upx_exe = upx$e
-include $(srcdir)/Makefile.inc
-ifneq ($(strip $(wildcard $(NRVDIR)/include/nrv)),)
-  u = nrv
-  U = NRV
-  upx_exe = upx_$u$e
-  include $(srcdir)/Makefile.inc
-endif
-
-tmp := -Wl,--rpath,
-LDRPATH := $(addprefix $(tmp),$(LIBDIRS))
-LIBDIRS += .
-LDLIBDIRS := $(addprefix -L,$(LIBDIRS))
-
-##LDFLAGS += $(LDRPATH)
-LDFLAGS += $(LDLIBDIRS)
-
-
-###
-### linux/i386
-###
-
-ifeq ($(target),linux)
-e =
-###CC = /usr/local/packages/gcc-cvs/bin/g++
-DEFS += '-DUPX_CONFIG_H="config_h/linux.h"'
-##CFLAGS_M += -mno-schedule-prologue
-CFLAGS_M += -march=i386 -mcpu=pentium
-CFLAGS_WERROR = -Werror
-LDLIBS += -lmcheck
-
-ifeq (1,2) 	# checkergcc
-  CC = checkergcc
-  CXX = checkerg++
-else
-ifeq ($(DEBUG),1)
-  ##CFLAGS += -O0 -gstabs+3
-  CFLAGS += -O0 -gdwarf-2
-else
-  ##LDFLAGS += -static
-  STUBEDIT_EXE = objcopy -S -R .comment -R .note $@ && perl $(srcdir)/stub/scripts/brandelf.pl $@ && chmod 755 $@
+# search for the UPX testsuite -- git clone https://github.com/upx/upx-testsuite.git
+# you also can override upx_testsuite_SRCDIR
+ifndef upx_testsuite_SRCDIR
+# search standard locations below $(top_srcdir)
+ifneq ($(wildcard $(top_srcdir)/../upx--upx-testsuite.git/files/packed/.),)
+upx_testsuite_SRCDIR := $(top_srcdir)/../upx--upx-testsuite.git
+else ifneq ($(wildcard $(top_srcdir)/../upx-testsuite.git/files/packed/.),)
+upx_testsuite_SRCDIR := $(top_srcdir)/../upx-testsuite.git
+else ifneq ($(wildcard $(top_srcdir)/../upx-testsuite/files/packed/.),)
+upx_testsuite_SRCDIR := $(top_srcdir)/../upx-testsuite
 endif
 endif
 
-endif	# linux
-
-
-###
-### djgpp2
-###
-
-ifeq ($(target),djgpp2)
-CFLAGS_M += -mno-schedule-prologue
-CFLAGS_M += -march=i386 -mcpu=pentium
-CFLAGS_WERROR = -Werror
-STUBEDIT_EXE = stubedit $@ bufsize=0xfc00
-endif	# djgpp2
-
-
-###
-### cygwin / mingw32
-###
-
-ifeq ($(target),cygwin)
-CFLAGS_M += -mno-schedule-prologue
-CFLAGS_M += -march=i386 -mcpu=pentium
-CFLAGS_WERROR = -Werror
+# run the UPX testsuite
+# The expected (old) checksums are in $(top_srcdir)/misc/testsuite/upx_testsuite_1-expected_sha256sums.sh
+# The   actual (new) checksums are in ./tmp-upx-testsuite/testsuite_1/.sha256sums.recreate
+ifneq ($(wildcard $(upx_testsuite_SRCDIR)/files/packed/.),)
+ifneq ($(wildcard $(top_srcdir)/misc/testsuite/upx_testsuite_1.sh),)
+run-testsuite: run-testsuite-release
+run-testsuite-%: export upx_testsuite_SRCDIR   := $(upx_testsuite_SRCDIR)
+run-testsuite-%: export upx_testsuite_BUILDDIR := ./tmp-upx-testsuite
+run-testsuite-debug: export upx_exe := $(top_srcdir)/build/debug/upx
+run-testsuite-debug: PHONY $(top_srcdir)/build/debug/upx
+	time -p bash $(top_srcdir)/misc/testsuite/upx_testsuite_1.sh
+run-testsuite-release: export upx_exe := $(top_srcdir)/build/release/upx
+run-testsuite-release: PHONY $(top_srcdir)/build/release/upx
+	time -p bash $(top_srcdir)/misc/testsuite/upx_testsuite_1.sh
+endif
 endif
 
-ifeq ($(target),mingw32)
-CFLAGS_M += -mno-schedule-prologue
-CFLAGS_M += -march=i386 -mcpu=pentium
+#
+# "make clang-format"
+#
+
+# automatically format some C++ source code files
+ifeq ($(shell uname),Linux)
+# Markus loves clang-format, but John hates it; find a compromise
+CLANG_FORMAT_EXCLUDE_FILES += conf.h miniacc.h version.h packer_c.cpp
+CLANG_FORMAT_EXCLUDE_FILES += p_elf.h p_elf_enum.h p_lx_% p_mach% p_unix% p_vmlin%
+CLANG_FORMAT_EXCLUDE_FILES += compress/compress.h filter/filter_impl.cpp
+CLANG_FORMAT_FILES := $(sort $(wildcard *.[ch]* ../maint/src/*.[ch]* [cu]*/*.[ch]*))
+CLANG_FORMAT_FILES := $(filter-out $(CLANG_FORMAT_EXCLUDE_FILES),$(CLANG_FORMAT_FILES))
+clang-format: PHONY $(CLANG_FORMAT_FILES)
+	@echo "running upx-clang-format"
+	@$(top_srcdir)/misc/scripts/upx-clang-format.sh -i $(CLANG_FORMAT_FILES)
 endif
 
-# mingw32 as included in cygwin
-ifeq ($(target),no-cygwin)
-CC = gcc -mno-cygwin
-CFLAGS_M += -mno-schedule-prologue
-CFLAGS_M += -march=i386 -mcpu=pentium
-CFLAGS_WERROR = -Werror
+#
+# "make check-whitespace"
+#
+
+CHECK_WHITESPACE =
+ifeq ($(shell uname),Linux)
+CHECK_WHITESPACE = $(top_srcdir)/misc/scripts/check_whitespace.sh $(top_srcdir)
+ifneq ($(wildcard $(top_srcdir)/.git/.),)
+CHECK_WHITESPACE = $(top_srcdir)/misc/scripts/check_whitespace_git.sh $(top_srcdir)
+endif
+check-whitespace: PHONY; $(CHECK_WHITESPACE)
 endif
 
-
-###
-### Microsoft 32-bit C/C++ Compiler 12.00 (aka Visual C++ 6)
-###
-
-ifeq ($(target),vc6)
-o = .obj
-a = .lib
-CC = cl -nologo
-CFLAGS = -W4 -WX
-CXXFLAGS1 = $(CFLAGS) -GR -GX -EHa
-CXXFLAGS2 = $(CFLAGS)
-LDFLAGS =
-LINK_LDFLAGS = /link /map:$T.map
-
-ifneq ($(strip $(DOS_LIBDIRS)),)
-LIB := $(DOS_LIBDIRS);$(LIB)
-endif
-export LIB
-
-ifeq (1,2)
-  # statically link libc.lib
-  CC += -ML
-  ##LDLIBS = $(u)_s.lib zlib_s.lib setargv.obj
-  LDLIBS = $(u)_s.lib setargv.obj
-else
-  # link against msvcrt.dll
-  CC += -MD
-  LDLIBS = $(DOS_LDLIBS) zlib.lib setargv.obj
-endif
-ifeq ($(DEBUG),1)
-  CFLAGS += -Od -ZI
-  LINK_LDFLAGS += /debug
-else
-  CFLAGS += -O2 -GF
-  LINK_LDFLAGS += /release
-endif
-
-##LINK_LDFLAGS += /verbose
-LINK_EXE = $(CC) $(LDFLAGS) $(EXTRA_LDFLAGS) -Fe$@ $^ $(LDLIBS) $(LINK_LDFLAGS)
-
-endif	# vc6
-
-
-###
-### sparc
-###
-
-ifeq ($(target),sparc)
-e =
-DEFS += '-DUPX_CONFIG_H="config_h/sparc.h"'
-INCLUDES += -I/home/ethmola/local/include
-
-ifeq (1,2) # native compiler
-  CFLAGS = -O0 -g
-  CXXFLAGS1 =
-  CXXFLAGS2 =
-  CFLAGS_M =
-  DEFS += -DUSE_STDNAMESPACE
-else # gcc
-  CFLAGS += -O0 -gstabs+
-endif
-
-ifeq (1,2) # purify
-  DEFS += -D__PURIFY__
-  LDFLAGS = -g -L/home/ethmola/local/lib
-  LINK_EXE = purify $(CC) $(LDFLAGS) $(EXTRA_LDFLAGS) -o $@ $^ $(LDLIBS)
-else
-  LDFLAGS += -g -L/home/ethmola/local/lib
-  LINK_EXE = $(CC) $(LDFLAGS) $(EXTRA_LDFLAGS) -o $@ $^ $(LDLIBS)
-endif
-
-endif	# sparc
-
-
-###
-### Borland C++ 5.5 (DOES NOT WORK - INCOMPLETE C++ IMPLEMENTATION)
-###
-
-ifeq ($(target),bcc)
-o = .obj
-a = .lib
-CC = bcc32
-CFLAGS = -w -w-par
-CXXFLAGS1 = $(CFLAGS)
-CXXFLAGS2 = $(CFLAGS)
-CFLAGS_OUTPUT = -o$@
-LDFLAGS =
-LDLIBS = $(DOS_LDLIBS) zlib.lib
-
-ifneq ($(strip $(DOS_LIBDIRS)),)
-LIB := $(DOS_LIBDIRS);$(LIB)
-endif
-export LIB
-
-ifeq ($(DEBUG),1)
-  CFLAGS += -Od -d
-else
-  CFLAGS += -O2 -d
-endif
-
-LINK_EXE = $(CC) $(LDFLAGS) $(EXTRA_LDFLAGS) -e$@ $^ $(LDLIBS)
-
-endif	# bcc
-
-
-###
-### malloc debuggers (Linux only)
-###
-
-ifeq (1,2)
-  LDLIBS += -lefence
-endif
-
-ifeq (1,2)
-  CFLAGS += -DWITH_DMALLOC
-  LDLIBS += -ldmalloc
-endif
-
-ifeq (1,2)
-  CFLAGS += -DWITH_GC -DLINUX_THREADS -D_REENTRANT
-  LDLIBS += -lgc -lpthread
-  # only needed when using -static:
-  ##LDFLAGS += -Wl,-defsym,_DYNAMIC=0
-endif
-
-ifeq (1,2)
-  CFLAGS += -DWITH_MSS
-  LDLIBS += -lmss
-endif
-
-
-# /***********************************************************************
-# // main targets
-# ************************************************************************/
-
-all: $(upx_exe)
-
-.PHONY: all unupx mostlyclean clean distclean maintainer-clean untabify tags
-
-$(upx_exe): $(OBJECTS) $(LIBS)
-	$(LINK_EXE)
-	$(STUBEDIT_EXE)
-
-
-ifeq ($(target),djgpp2)
-cwsbind: $(upx_exe)
-	-rm -f $T.cof
-	$(upx_exe) -1 --coff -o $T.cof $(upx_exe)
-	cat $(DJDIR)/bin/cwsdstub.exe $T.cof > $(upx_exe)
-	$(upx_exe) -d $(upx_exe)
-	$(upx_exe) --best $(upx_exe)
-endif
-
-
-unupx:
-	$(MAKE) target=vc6 unupx.dll
-
-unupx.dll: $(OBJECTS) $(LIBS)
-	$(LINK_DLL)
-
-
-mostlyclean:
-	-rm -f *.d *.err *.i *.log *.map *~ gdb-trans*
-
-clean: mostlyclean
-	-rm -f *.a *.lib *.o *.obj tags TAGS ID
-	-rm -f *.idb *.pdb
-	-rm -f upx upx.exe upx_nrv upx_nrv.exe upx_ucl upx_ucl.exe
-
-distclean: clean
-
-maintainer-clean: distclean
-
-
-untabify:
-	mfxtu -d4 -t *.h *.cpp *.ch
-	mfxtu -d8 -t stub/[ln]*.asm stub/*.ash stub/*.[cs]
-
-tags TAGS:
-	ctags *.h *.cpp *.ch
-
-ID:
-	mkid *.h *.cpp *.ch
-
-
-# /***********************************************************************
-# // rules
-# ************************************************************************/
-
-.c$o:
-	$(CC) $(DEFS) $(INCLUDES) $(CFLAGS) $(CFLAGS_OUTPUT) -c $<
-
-.cpp$o:
-	$(CXX) $(DEFS) $(INCLUDES) $(CXXFLAGS1) $(CXXFLAGS_OUTPUT) -c $<
-
-$(OBJECTS1): %$o : %.cpp
-	$(CXX) $(DEFS) $(INCLUDES) $(CXXFLAGS1) $(CXXFLAGS_OUTPUT) -c $<
-
-$(OBJECTS2): %$o : %.cpp
-	$(CXX) $(DEFS) $(INCLUDES) $(CXXFLAGS2) $(CXXFLAGS_OUTPUT) -c $<
-
-ifneq ($(strip $(OBJECTS3)),)
-$(OBJECTS3): %$o : %.c
-	$(CC) $(DEFS) $(INCLUDES) $(CFLAGS) $(CFLAGS_OUTPUT) -c $<
-endif
-
-
-# /***********************************************************************
-# // dependencies
-# ************************************************************************/
-
-# FIXME: use automated dependencies
-
-main$o:     mygetopt.h version.h
-filter$o:   filter.h
-filteri$o:  filter.h fcto_ml.ch fcto_ml2.ch fcto_ml3.ch
-help$o:     version.h
-msg$o:      ui.h
-lefile$o:   lefile.h
-linker$o:   linker.h
-mygetopt$o: mygetopt.h
-packer$o:   packer.h filter.h linker.h ui.h version.h
-packhead$o: packer.h
-packmast$o: packmast.h packer.h lefile.h \
-		p_com.h p_djgpp2.h p_exe.h p_lx_elf.h p_lx_sep.h p_lx_sh.h \
-		p_sys.h p_tmt.h p_tos.h \
-		p_unix.h p_vmlinz.h p_vxd.h p_w32pe.h p_wcle.h
-ui$o:       packer.h ui.h
-work$o:     packer.h ui.h packmast.h
-
-p_com$o:    packer.h p_com.h \
-		stub/l_com.h
-p_djgpp2$o: packer.h p_djgpp2.h stub/stubify.h \
-		stub/l_djgpp2.h
-p_exe$o:    packer.h p_exe.h \
-		stub/l_exe.h
-p_lx_elf$o: packer.h p_lx_elf.h p_unix.h p_elf.h \
-		stub/l_le_n2b.h stub/l_le_n2d.h
-p_lx_sep$o: packer.h p_lx_sep.h p_lx_elf.h p_unix.h p_elf.h
-p_lx_sh$o:  packer.h p_lx_sh.h p_lx_elf.h p_unix.h p_elf.h \
-		stub/l_sh_n2b.h stub/l_sh_n2d.h
-p_sys$o:    packer.h p_sys.h p_com.h \
-		stub/l_sys.h
-p_tmt$o:    packer.h p_tmt.h \
-		stub/l_tmt.h
-p_tos$o:    packer.h p_tos.h \
-		stub/l_t_n2b.h stub/l_t_n2bs.h \
-		stub/l_t_n2d.h stub/l_t_n2ds.h
-p_unix$o:   packer.h p_unix.h p_elf.h \
-		stub/l_lx_n2b.h stub/l_lx_n2d.h
-p_vmlinz$o: packer.h p_vmlinz.h \
-		stub/l_vmlinz.h
-p_w32pe$o:  packer.h p_w32pe.h \
-		stub/l_w32pe.h
-p_wcle$o:   packer.h p_wcle.h lefile.h \
-		stub/l_wcle.h
-
-# vi:nowrap
+# vim:set ts=8 sw=8 noet:

src/Makefile.inc

@@ -1,37 +0,0 @@
-UDIR := $($(U)DIR)
-
-DEFS += -DWITH_$(U)
-
-ifneq ($(strip $(wildcard $(UDIR)/include)),)
-INCLUDES += -I$(UDIR)/include
-endif
-
-ifneq ($(strip $(wildcard $(UDIR)/src/.libs)),)
-LIBDIRS += $(UDIR)/src/.libs
-endif
-ifeq ($(DEBUG),1)
-ifneq ($(strip $(wildcard $(UDIR)/build/debug/src/.libs)),)
-LIBDIRS += $(UDIR)/build/debug/src/.libs
-endif
-endif
-ifneq ($(strip $(wildcard $(UDIR)/build/release/src/.libs)),)
-LIBDIRS += $(UDIR)/build/release/src/.libs
-endif
-ifneq ($(strip $(wildcard $(UDIR)/build/src/.libs)),)
-LIBDIRS += $(UDIR)/build/src/.libs
-endif
-ifneq ($(strip $(wildcard $(UDIR))),)
-LIBDIRS += $(UDIR)
-DOS_LIBDIRS := $(DOS_LIBDIRS);$(UDIR)
-endif
-
-LDLIBS += -l$(u)
-DOS_LDLIBS += $(u).lib
-
-
-DEFS := $(DEFS)
-INCLUDES := $(INCLUDES)
-LIBDIRS := $(LIBDIRS)
-LDLIBS := $(LDLIBS)
-DOS_LDLIBS := $(DOS_LDLIBS)
-

src/bele.h

@@ -1,9 +1,9 @@
-/* bele.h --
+/* bele.h -- access memory in BigEndian and LittleEndian byte order
 
    This file is part of the UPX executable compressor.
 
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
    All Rights Reserved.
 
    UPX and the UCL library are free software; you can redistribute them
@@ -22,241 +22,744 @@
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
  */
 
+#pragma once
 
-#ifndef __UPX_BELE_H
-#define __UPX_BELE_H
+// BE - Big Endian
+// LE - Little Endian
+// NE - Native Endianness (aka Host Endianness aka CPU Endianness)
+// TE - Target Endianness (not used here, see various packers)
 
+#if 1
+// some platforms may provide their own system bswapXX() functions, so rename to avoid conflicts
+#undef bswap16
+#undef bswap32
+#undef bswap64
+#define bswap16 upx_bswap16
+#define bswap32 upx_bswap32
+#define bswap64 upx_bswap64
+#endif
 
 /*************************************************************************
-// access memory in BigEndian and LittleEndian byte order
+// core - NE
 **************************************************************************/
 
-inline unsigned short get_be16(const void *bb, int off=0)
-{
-    const upx_bytep const b = reinterpret_cast<const upx_bytep>(bb) + off;
-    unsigned v;
-    v  = (unsigned) b[1] <<  0;
-    v |= (unsigned) b[0] <<  8;
-    return (unsigned short) v;
-}
-
-inline void set_be16(void *bb, unsigned v, int off=0)
-{
-    upx_bytep const b = reinterpret_cast<upx_bytep>(bb) + off;
-    b[1] = (unsigned char) (v >>  0);
-    b[0] = (unsigned char) (v >>  8);
-}
-
-
-inline unsigned get_be32(const void *bb, int off=0)
-{
-    const upx_bytep const b = reinterpret_cast<const upx_bytep>(bb) + off;
-    unsigned v;
-    v  = (unsigned) b[3] <<  0;
-    v |= (unsigned) b[2] <<  8;
-    v |= (unsigned) b[1] << 16;
-    v |= (unsigned) b[0] << 24;
+static forceinline unsigned get_ne16(const void *p) noexcept {
+    upx_uint16_t v = 0;
+    upx_memcpy_inline(&v, p, sizeof(v));
     return v;
 }
 
-inline void set_be32(void *bb, unsigned v, int off=0)
-{
-    upx_bytep const b = reinterpret_cast<upx_bytep>(bb) + off;
-    b[3] = (unsigned char) (v >>  0);
-    b[2] = (unsigned char) (v >>  8);
-    b[1] = (unsigned char) (v >> 16);
-    b[0] = (unsigned char) (v >> 24);
-}
-
-
-inline unsigned short get_le16(const void *bb, int off=0)
-{
-    const upx_bytep const b = reinterpret_cast<const upx_bytep>(bb) + off;
-    unsigned v;
-#if defined(__i386__)
-    v = * (const unsigned short *) b;
-#else
-    v  = (unsigned) b[0] <<  0;
-    v |= (unsigned) b[1] <<  8;
-#endif
-    return (unsigned short) v;
-}
-
-inline void set_le16(void *bb, unsigned v, int off=0)
-{
-    upx_bytep const b = reinterpret_cast<upx_bytep>(bb) + off;
-#if defined(__i386__)
-    (* (unsigned short *) b) = (unsigned short) v;
-#else
-    b[0] = (unsigned char) (v >>  0);
-    b[1] = (unsigned char) (v >>  8);
-#endif
-}
-
-
-inline unsigned get_le24(const void *bb, int off=0)
-{
-    const upx_bytep const b = reinterpret_cast<const upx_bytep>(bb) + off;
-    unsigned v;
-    v  = (unsigned) b[0] <<  0;
-    v |= (unsigned) b[1] <<  8;
-    v |= (unsigned) b[2] << 16;
+static forceinline unsigned get_ne32(const void *p) noexcept {
+    upx_uint32_t v = 0;
+    upx_memcpy_inline(&v, p, sizeof(v));
     return v;
 }
 
-inline void set_le24(void *bb, unsigned v, int off=0)
-{
-    upx_bytep const b = reinterpret_cast<upx_bytep>(bb) + off;
-    b[0] = (unsigned char) (v >>  0);
-    b[1] = (unsigned char) (v >>  8);
-    b[2] = (unsigned char) (v >> 16);
-}
-
-
-inline unsigned get_le32(const void *bb, int off=0)
-{
-    const upx_bytep const b = reinterpret_cast<const upx_bytep>(bb) + off;
-    unsigned v;
-#if defined(__i386__)
-    v = * (const unsigned *) b;
-#else
-    v  = (unsigned) b[0] <<  0;
-    v |= (unsigned) b[1] <<  8;
-    v |= (unsigned) b[2] << 16;
-    v |= (unsigned) b[3] << 24;
-#endif
+static forceinline upx_uint64_t get_ne64(const void *p) noexcept {
+    upx_uint64_t v = 0;
+    upx_memcpy_inline(&v, p, sizeof(v));
     return v;
 }
 
-inline void set_le32(void *bb, unsigned v, int off=0)
-{
-    upx_bytep const b = reinterpret_cast<upx_bytep>(bb) + off;
-#if defined(__i386__)
-    (* (unsigned *) b) = v;
-#else
-    b[0] = (unsigned char) (v >>  0);
-    b[1] = (unsigned char) (v >>  8);
-    b[2] = (unsigned char) (v >> 16);
-    b[3] = (unsigned char) (v >> 24);
-#endif
+static forceinline void set_ne16(void *p, unsigned vv) noexcept {
+    upx_uint16_t v = (upx_uint16_t) (vv & 0xffff);
+    upx_memcpy_inline(p, &v, sizeof(v));
 }
 
+static forceinline void set_ne32(void *p, unsigned vv) noexcept {
+    upx_uint32_t v = vv;
+    upx_memcpy_inline(p, &v, sizeof(v));
+}
+
+static forceinline void set_ne64(void *p, upx_uint64_t vv) noexcept {
+    upx_uint64_t v = vv;
+    upx_memcpy_inline(p, &v, sizeof(v));
+}
+
+/*************************************************************************
+// core - bswap
+**************************************************************************/
+
+#if (ACC_CC_MSC)
+
+ACC_COMPILE_TIME_ASSERT_HEADER(sizeof(long) == 4)
+
+// unfortunately *not* constexpr with current MSVC
+static forceinline unsigned bswap16(unsigned v) noexcept {
+    return (unsigned) _byteswap_ulong(v << 16);
+}
+static forceinline unsigned bswap32(unsigned v) noexcept { return (unsigned) _byteswap_ulong(v); }
+static forceinline upx_uint64_t bswap64(upx_uint64_t v) noexcept { return _byteswap_uint64(v); }
+
+#else
+
+static forceinline constexpr unsigned bswap16(unsigned v) noexcept {
+    // return __builtin_bswap16((upx_uint16_t) (v & 0xffff));
+    // return (unsigned) __builtin_bswap64((upx_uint64_t) v << 48);
+    return __builtin_bswap32(v << 16);
+}
+static forceinline constexpr unsigned bswap32(unsigned v) noexcept {
+    // return (unsigned) __builtin_bswap64((upx_uint64_t) v << 32);
+    return __builtin_bswap32(v);
+}
+static forceinline constexpr upx_uint64_t bswap64(upx_uint64_t v) noexcept {
+    return __builtin_bswap64(v);
+}
+
+#endif
+
+static forceinline constexpr unsigned no_bswap16(unsigned v) noexcept {
+    // mask is needed so that for all v: bswap16(bswap16(v)) == no_bswap16(v)
+    return v & 0xffff;
+}
+static forceinline constexpr unsigned no_bswap32(unsigned v) noexcept { return v; }
+static forceinline constexpr upx_uint64_t no_bswap64(upx_uint64_t v) noexcept { return v; }
+
+#if (ACC_ABI_BIG_ENDIAN)
+#define ne16_to_be16(v) no_bswap16(v)
+#define ne32_to_be32(v) no_bswap32(v)
+#define ne64_to_be64(v) no_bswap64(v)
+#define ne16_to_le16(v) bswap16(v)
+#define ne32_to_le32(v) bswap32(v)
+#define ne64_to_le64(v) bswap64(v)
+#else
+#define ne16_to_be16(v) bswap16(v)
+#define ne32_to_be32(v) bswap32(v)
+#define ne64_to_be64(v) bswap64(v)
+#define ne16_to_le16(v) no_bswap16(v)
+#define ne32_to_le32(v) no_bswap32(v)
+#define ne64_to_le64(v) no_bswap64(v)
+#endif
+
+/*************************************************************************
+// get/set 16/32/64
+**************************************************************************/
+
+inline unsigned get_be16(const void *p) noexcept { return ne16_to_be16(get_ne16(p)); }
+inline unsigned get_be32(const void *p) noexcept { return ne32_to_be32(get_ne32(p)); }
+inline upx_uint64_t get_be64(const void *p) noexcept { return ne64_to_be64(get_ne64(p)); }
+inline unsigned get_le16(const void *p) noexcept { return ne16_to_le16(get_ne16(p)); }
+inline unsigned get_le32(const void *p) noexcept { return ne32_to_le32(get_ne32(p)); }
+inline upx_uint64_t get_le64(const void *p) noexcept { return ne64_to_le64(get_ne64(p)); }
+inline void set_be16(void *p, unsigned v) noexcept { set_ne16(p, ne16_to_be16(v)); }
+inline void set_be32(void *p, unsigned v) noexcept { set_ne32(p, ne32_to_be32(v)); }
+inline void set_be64(void *p, upx_uint64_t v) noexcept { set_ne64(p, ne64_to_be64(v)); }
+inline void set_le16(void *p, unsigned v) noexcept { set_ne16(p, ne16_to_le16(v)); }
+inline void set_le32(void *p, unsigned v) noexcept { set_ne32(p, ne32_to_le32(v)); }
+inline void set_le64(void *p, upx_uint64_t v) noexcept { set_ne64(p, ne64_to_le64(v)); }
+
+/*************************************************************************
+// get/set 24/26
+**************************************************************************/
+
+inline unsigned get_be24(const void *p) noexcept {
+    const byte *b = ACC_CCAST(const byte *, p);
+    return (b[0] << 16) | (b[1] << 8) | (b[2] << 0);
+}
+
+inline unsigned get_le24(const void *p) noexcept {
+    const byte *b = ACC_CCAST(const byte *, p);
+    return (b[0] << 0) | (b[1] << 8) | (b[2] << 16);
+}
+
+inline void set_be24(void *p, unsigned v) noexcept {
+    byte *b = ACC_PCAST(byte *, p);
+    b[0] = ACC_ICONV(byte, (v >> 16) & 0xff);
+    b[1] = ACC_ICONV(byte, (v >> 8) & 0xff);
+    b[2] = ACC_ICONV(byte, (v >> 0) & 0xff);
+}
+
+inline void set_le24(void *p, unsigned v) noexcept {
+    byte *b = ACC_PCAST(byte *, p);
+    b[0] = ACC_ICONV(byte, (v >> 0) & 0xff);
+    b[1] = ACC_ICONV(byte, (v >> 8) & 0xff);
+    b[2] = ACC_ICONV(byte, (v >> 16) & 0xff);
+}
+
+inline unsigned get_le26(const void *p) noexcept { return get_le32(p) & 0x03ffffff; }
+inline unsigned get_le19_5(const void *p) noexcept { return (get_le32(p) >> 5) & 0x0007ffff; }
+inline unsigned get_le14_5(const void *p) noexcept { return (get_le32(p) >> 5) & 0x00003fff; }
+
+inline void set_le26(void *p, unsigned v) noexcept {
+    // preserve the top 6 bits
+    //   set_le32(p, (get_le32(p) & 0xfc000000) | (v & 0x03ffffff));
+    // optimized version, saving a runtime bswap32
+    set_ne32(p, (get_ne32(p) & ne32_to_le32(0xfc000000)) |
+                    (ne32_to_le32(v) & ne32_to_le32(0x03ffffff)));
+}
+inline void set_le19_5(void *p, unsigned v) noexcept {
+    set_le32(p, (get_le32(p) & 0xff00001f) | ((v & 0x0007ffff) << 5));
+}
+inline void set_le14_5(void *p, unsigned v) noexcept {
+    set_le32(p, (get_le32(p) & 0xfff8001f) | ((v & 0x00003fff) << 5));
+}
+
+/*************************************************************************
+// get signed values
+**************************************************************************/
+
+static forceinline int sign_extend(unsigned v, unsigned bits) noexcept {
+    const unsigned sign_bit = 1u << (bits - 1);
+    v &= sign_bit | (sign_bit - 1);
+    v |= 0u - (v & sign_bit);
+    return ACC_ICAST(int, v);
+}
+
+static forceinline upx_int64_t sign_extend(upx_uint64_t v, unsigned bits) noexcept {
+    const upx_uint64_t sign_bit = 1ull << (bits - 1);
+    v &= sign_bit | (sign_bit - 1);
+    v |= 0ull - (v & sign_bit);
+    return ACC_ICAST(upx_int64_t, v);
+}
+
+inline int get_be16_signed(const void *p) noexcept {
+    unsigned v = get_be16(p);
+    return sign_extend(v, 16);
+}
+
+inline int get_be24_signed(const void *p) noexcept {
+    unsigned v = get_be24(p);
+    return sign_extend(v, 24);
+}
+
+inline int get_be32_signed(const void *p) noexcept {
+    unsigned v = get_be32(p);
+    return sign_extend(v, 32);
+}
+
+inline upx_int64_t get_be64_signed(const void *p) noexcept {
+    upx_uint64_t v = get_be64(p);
+    return sign_extend(v, 64);
+}
+
+inline int get_le16_signed(const void *p) noexcept {
+    unsigned v = get_le16(p);
+    return sign_extend(v, 16);
+}
+
+inline int get_le24_signed(const void *p) noexcept {
+    unsigned v = get_le24(p);
+    return sign_extend(v, 24);
+}
+
+inline int get_le32_signed(const void *p) noexcept {
+    unsigned v = get_le32(p);
+    return sign_extend(v, 32);
+}
+
+inline upx_int64_t get_le64_signed(const void *p) noexcept {
+    upx_uint64_t v = get_le64(p);
+    return sign_extend(v, 64);
+}
 
 /*************************************************************************
 // classes for portable unaligned access
+//
+// Important: these classes must be PODs (Plain Old Data), i.e. no
+//   constructor, no destructor, no virtual functions and no default
+//   assignment operator, and all fields must be public(!).
+//
+// [Actually we _can_ use a safe non-POD subset, but for this we need
+//  to have gcc bug 17519 fixed - see http://gcc.gnu.org/PR17519 ]
 **************************************************************************/
 
-class BE16
-{
-    unsigned char d[2];
+struct alignas(1) BE16 final {
+    typedef unsigned integral_conversion_type; // automatic conversion to unsigned
+    byte d[2];
 
-public:
-    BE16& operator =  (const BE16 &v) { memcpy(d, v.d, sizeof(d)); return *this; }
+    forceinline operator unsigned() const noexcept { return get_be16(d); }
 
-    BE16& operator =  (unsigned v)    { set_be16(d, v); return *this; }
-    BE16& operator += (unsigned v)    { set_be16(d, get_be16(d) + v); return *this; }
-    BE16& operator -= (unsigned v)    { set_be16(d, get_be16(d) - v); return *this; }
-    BE16& operator &= (unsigned v)    { set_be16(d, get_be16(d) & v); return *this; }
-    BE16& operator |= (unsigned v)    { set_be16(d, get_be16(d) | v); return *this; }
+    forceinline BE16 &operator=(unsigned v) noexcept {
+        set_be16(d, v);
+        return *this;
+    }
+    BE16 &operator+=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) + v);
+        return *this;
+    }
+    BE16 &operator-=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) - v);
+        return *this;
+    }
+    BE16 &operator*=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) * v);
+        return *this;
+    }
+    BE16 &operator/=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) / v);
+        return *this;
+    }
+    BE16 &operator&=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) & v);
+        return *this;
+    }
+    BE16 &operator|=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) | v);
+        return *this;
+    }
+    BE16 &operator^=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) ^ v);
+        return *this;
+    }
+    BE16 &operator<<=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) << v);
+        return *this;
+    }
+    BE16 &operator>>=(unsigned v) noexcept {
+        set_be16(d, get_be16(d) >> v);
+        return *this;
+    }
 
-    operator const unsigned () const  { return get_be16(d); }
+    bool operator==(const BE16 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const BE16 &x) const noexcept { return unsigned(*this) < unsigned(x); }
 };
 
+struct alignas(1) BE32 final {
+    typedef unsigned integral_conversion_type; // automatic conversion to unsigned
+    byte d[4];
 
-class BE32
-{
-    unsigned char d[4];
+    forceinline operator unsigned() const noexcept { return get_be32(d); }
 
-public:
-    BE32& operator =  (const BE32 &v) { memcpy(d, v.d, sizeof(d)); return *this; }
+    forceinline BE32 &operator=(unsigned v) noexcept {
+        set_be32(d, v);
+        return *this;
+    }
+    BE32 &operator+=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) + v);
+        return *this;
+    }
+    BE32 &operator-=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) - v);
+        return *this;
+    }
+    BE32 &operator*=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) * v);
+        return *this;
+    }
+    BE32 &operator/=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) / v);
+        return *this;
+    }
+    BE32 &operator&=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) & v);
+        return *this;
+    }
+    BE32 &operator|=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) | v);
+        return *this;
+    }
+    BE32 &operator^=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) ^ v);
+        return *this;
+    }
+    BE32 &operator<<=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) << v);
+        return *this;
+    }
+    BE32 &operator>>=(unsigned v) noexcept {
+        set_be32(d, get_be32(d) >> v);
+        return *this;
+    }
 
-    BE32& operator =  (unsigned v)    { set_be32(d, v); return *this; }
-    BE32& operator += (unsigned v)    { set_be32(d, get_be32(d) + v); return *this; }
-    BE32& operator -= (unsigned v)    { set_be32(d, get_be32(d) - v); return *this; }
-    BE32& operator &= (unsigned v)    { set_be32(d, get_be32(d) & v); return *this; }
-    BE32& operator |= (unsigned v)    { set_be32(d, get_be32(d) | v); return *this; }
-
-    operator const unsigned () const  { return get_be32(d); }
+    bool operator==(const BE32 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const BE32 &x) const noexcept { return unsigned(*this) < unsigned(x); }
 };
 
+struct alignas(1) BE64 final {
+    typedef upx_uint64_t integral_conversion_type; // automatic conversion to upx_uint64_t
+    byte d[8];
 
-class LE16
-{
-    unsigned char d[2];
+    forceinline operator upx_uint64_t() const noexcept { return get_be64(d); }
 
-public:
-    LE16& operator =  (const LE16 &v) { memcpy(d, v.d, sizeof(d)); return *this; }
+    forceinline BE64 &operator=(upx_uint64_t v) noexcept {
+        set_be64(d, v);
+        return *this;
+    }
+    BE64 &operator+=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) + v);
+        return *this;
+    }
+    BE64 &operator-=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) - v);
+        return *this;
+    }
+    BE64 &operator*=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) * v);
+        return *this;
+    }
+    BE64 &operator/=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) / v);
+        return *this;
+    }
+    BE64 &operator&=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) & v);
+        return *this;
+    }
+    BE64 &operator|=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) | v);
+        return *this;
+    }
+    BE64 &operator^=(upx_uint64_t v) noexcept {
+        set_be64(d, get_be64(d) ^ v);
+        return *this;
+    }
+    BE64 &operator<<=(unsigned v) noexcept {
+        set_be64(d, get_be64(d) << v);
+        return *this;
+    }
+    BE64 &operator>>=(unsigned v) noexcept {
+        set_be64(d, get_be64(d) >> v);
+        return *this;
+    }
 
-    LE16& operator =  (unsigned v)    { set_le16(d, v); return *this; }
-    LE16& operator += (unsigned v)    { set_le16(d, get_le16(d) + v); return *this; }
-    LE16& operator -= (unsigned v)    { set_le16(d, get_le16(d) - v); return *this; }
-    LE16& operator &= (unsigned v)    { set_le16(d, get_le16(d) & v); return *this; }
-    LE16& operator |= (unsigned v)    { set_le16(d, get_le16(d) | v); return *this; }
-
-    operator const unsigned () const  { return get_le16(d); }
+    bool operator==(const BE64 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const BE64 &x) const noexcept { return upx_uint64_t(*this) < upx_uint64_t(x); }
 };
 
+struct alignas(1) LE16 final {
+    typedef unsigned integral_conversion_type; // automatic conversion to unsigned
+    byte d[2];
 
-class LE32
-{
-    unsigned char d[4];
+    forceinline operator unsigned() const noexcept { return get_le16(d); }
 
-public:
-    LE32& operator =  (const LE32 &v) { memcpy(d, v.d, sizeof(d)); return *this; }
+    forceinline LE16 &operator=(unsigned v) noexcept {
+        set_le16(d, v);
+        return *this;
+    }
+    LE16 &operator+=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) + v);
+        return *this;
+    }
+    LE16 &operator-=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) - v);
+        return *this;
+    }
+    LE16 &operator*=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) * v);
+        return *this;
+    }
+    LE16 &operator/=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) / v);
+        return *this;
+    }
+    LE16 &operator&=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) & v);
+        return *this;
+    }
+    LE16 &operator|=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) | v);
+        return *this;
+    }
+    LE16 &operator^=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) ^ v);
+        return *this;
+    }
+    LE16 &operator<<=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) << v);
+        return *this;
+    }
+    LE16 &operator>>=(unsigned v) noexcept {
+        set_le16(d, get_le16(d) >> v);
+        return *this;
+    }
 
-    LE32& operator =  (unsigned v)    { set_le32(d, v); return *this; }
-    LE32& operator += (unsigned v)    { set_le32(d, get_le32(d) + v); return *this; }
-    LE32& operator -= (unsigned v)    { set_le32(d, get_le32(d) - v); return *this; }
-    LE32& operator &= (unsigned v)    { set_le32(d, get_le32(d) & v); return *this; }
-    LE32& operator |= (unsigned v)    { set_le32(d, get_le32(d) | v); return *this; }
-
-    operator const unsigned () const  { return get_le32(d); }
+    bool operator==(const LE16 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const LE16 &x) const noexcept { return unsigned(*this) < unsigned(x); }
 };
 
+struct alignas(1) LE32 final {
+    typedef unsigned integral_conversion_type; // automatic conversion to unsigned
+    byte d[4];
+
+    forceinline operator unsigned() const noexcept { return get_le32(d); }
+
+    forceinline LE32 &operator=(unsigned v) noexcept {
+        set_le32(d, v);
+        return *this;
+    }
+    LE32 &operator+=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) + v);
+        return *this;
+    }
+    LE32 &operator-=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) - v);
+        return *this;
+    }
+    LE32 &operator*=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) * v);
+        return *this;
+    }
+    LE32 &operator/=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) / v);
+        return *this;
+    }
+    LE32 &operator&=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) & v);
+        return *this;
+    }
+    LE32 &operator|=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) | v);
+        return *this;
+    }
+    LE32 &operator^=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) ^ v);
+        return *this;
+    }
+    LE32 &operator<<=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) << v);
+        return *this;
+    }
+    LE32 &operator>>=(unsigned v) noexcept {
+        set_le32(d, get_le32(d) >> v);
+        return *this;
+    }
+
+    bool operator==(const LE32 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const LE32 &x) const noexcept { return unsigned(*this) < unsigned(x); }
+};
+
+struct alignas(1) LE64 final {
+    typedef upx_uint64_t integral_conversion_type; // automatic conversion to upx_uint64_t
+    byte d[8];
+
+    forceinline operator upx_uint64_t() const noexcept { return get_le64(d); }
+
+    forceinline LE64 &operator=(upx_uint64_t v) noexcept {
+        set_le64(d, v);
+        return *this;
+    }
+    LE64 &operator+=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) + v);
+        return *this;
+    }
+    LE64 &operator-=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) - v);
+        return *this;
+    }
+    LE64 &operator*=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) * v);
+        return *this;
+    }
+    LE64 &operator/=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) / v);
+        return *this;
+    }
+    LE64 &operator&=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) & v);
+        return *this;
+    }
+    LE64 &operator|=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) | v);
+        return *this;
+    }
+    LE64 &operator^=(upx_uint64_t v) noexcept {
+        set_le64(d, get_le64(d) ^ v);
+        return *this;
+    }
+    LE64 &operator<<=(unsigned v) noexcept {
+        set_le64(d, get_le64(d) << v);
+        return *this;
+    }
+    LE64 &operator>>=(unsigned v) noexcept {
+        set_le64(d, get_le64(d) >> v);
+        return *this;
+    }
+
+    bool operator==(const LE64 &x) const noexcept { return memcmp(d, x.d, sizeof(d)) == 0; }
+    bool operator<(const LE64 &x) const noexcept { return upx_uint64_t(*this) < upx_uint64_t(x); }
+};
 
 /*************************************************************************
-// global operators
+// global operators (pointer addition/subtraction)
 **************************************************************************/
 
-inline bool operator < (const BE16& v1, const BE16& v2)
-{
-    return (const unsigned)v1 < (const unsigned)v2;
+template <class T>
+inline T *operator+(T *ptr, const BE16 &v) noexcept {
+    return ptr + unsigned(v);
 }
-
-inline bool operator < (const BE32& v1, const BE32& v2)
-{
-    return (const unsigned)v1 < (const unsigned)v2;
+template <class T>
+inline T *operator-(T *ptr, const BE16 &v) noexcept {
+    return ptr - unsigned(v);
 }
-
-inline bool operator < (const LE16& v1, const LE16& v2)
-{
-    return (const unsigned)v1 < (const unsigned)v2;
+template <class T>
+inline T *operator+(T *ptr, const BE32 &v) noexcept {
+    return ptr + unsigned(v);
 }
-
-inline bool operator < (const LE32& v1, const LE32& v2)
-{
-    return (const unsigned)v1 < (const unsigned)v2;
+template <class T>
+inline T *operator-(T *ptr, const BE32 &v) noexcept {
+    return ptr - unsigned(v);
+}
+template <class T>
+inline T *operator+(T *ptr, const LE16 &v) noexcept {
+    return ptr + unsigned(v);
+}
+template <class T>
+inline T *operator-(T *ptr, const LE16 &v) noexcept {
+    return ptr - unsigned(v);
+}
+template <class T>
+inline T *operator+(T *ptr, const LE32 &v) noexcept {
+    return ptr + unsigned(v);
+}
+template <class T>
+inline T *operator-(T *ptr, const LE32 &v) noexcept {
+    return ptr - unsigned(v);
 }
 
+// these are not implemented on purpose and will cause errors
+template <class T>
+T *operator+(T *ptr, const BE64 &v) noexcept DELETED_FUNCTION;
+template <class T>
+T *operator-(T *ptr, const BE64 &v) noexcept DELETED_FUNCTION;
+template <class T>
+T *operator+(T *ptr, const LE64 &v) noexcept DELETED_FUNCTION;
+template <class T>
+T *operator-(T *ptr, const LE64 &v) noexcept DELETED_FUNCTION;
 
 /*************************************************************************
-// misc
+// global overloads
 **************************************************************************/
 
+inline unsigned ALIGN_DOWN(unsigned a, const BE32 &b) { return ALIGN_DOWN(a, unsigned(b)); }
+inline unsigned ALIGN_DOWN(const BE32 &a, unsigned b) { return ALIGN_DOWN(unsigned(a), b); }
+inline unsigned ALIGN_UP(unsigned a, const BE32 &b) { return ALIGN_UP(a, unsigned(b)); }
+inline unsigned ALIGN_UP(const BE32 &a, unsigned b) { return ALIGN_UP(unsigned(a), b); }
+
+inline unsigned ALIGN_DOWN(unsigned a, const LE32 &b) { return ALIGN_DOWN(a, unsigned(b)); }
+inline unsigned ALIGN_DOWN(const LE32 &a, unsigned b) { return ALIGN_DOWN(unsigned(a), b); }
+inline unsigned ALIGN_UP(unsigned a, const LE32 &b) { return ALIGN_UP(a, unsigned(b)); }
+inline unsigned ALIGN_UP(const LE32 &a, unsigned b) { return ALIGN_UP(unsigned(a), b); }
+
+inline unsigned UPX_MAX(unsigned a, const BE16 &b) { return UPX_MAX(a, unsigned(b)); }
+inline unsigned UPX_MAX(const BE16 &a, unsigned b) { return UPX_MAX(unsigned(a), b); }
+inline unsigned UPX_MIN(unsigned a, const BE16 &b) { return UPX_MIN(a, unsigned(b)); }
+inline unsigned UPX_MIN(const BE16 &a, unsigned b) { return UPX_MIN(unsigned(a), b); }
+
+inline unsigned UPX_MAX(unsigned a, const BE32 &b) { return UPX_MAX(a, unsigned(b)); }
+inline unsigned UPX_MAX(const BE32 &a, unsigned b) { return UPX_MAX(unsigned(a), b); }
+inline unsigned UPX_MIN(unsigned a, const BE32 &b) { return UPX_MIN(a, unsigned(b)); }
+inline unsigned UPX_MIN(const BE32 &a, unsigned b) { return UPX_MIN(unsigned(a), b); }
+
+inline unsigned UPX_MAX(unsigned a, const LE16 &b) { return UPX_MAX(a, unsigned(b)); }
+inline unsigned UPX_MAX(const LE16 &a, unsigned b) { return UPX_MAX(unsigned(a), b); }
+inline unsigned UPX_MIN(unsigned a, const LE16 &b) { return UPX_MIN(a, unsigned(b)); }
+inline unsigned UPX_MIN(const LE16 &a, unsigned b) { return UPX_MIN(unsigned(a), b); }
+
+inline unsigned UPX_MAX(unsigned a, const LE32 &b) { return UPX_MAX(a, unsigned(b)); }
+inline unsigned UPX_MAX(const LE32 &a, unsigned b) { return UPX_MAX(unsigned(a), b); }
+inline unsigned UPX_MIN(unsigned a, const LE32 &b) { return UPX_MIN(a, unsigned(b)); }
+inline unsigned UPX_MIN(const LE32 &a, unsigned b) { return UPX_MIN(unsigned(a), b); }
+
+/*************************************************************************
+// misc support
+**************************************************************************/
+
+// native types
+#if (ACC_ABI_BIG_ENDIAN)
+typedef BE16 NE16;
+typedef BE32 NE32;
+typedef BE64 NE64;
+#define ne16_compare be16_compare
+#define ne32_compare be32_compare
+#define ne64_compare be64_compare
+#define ne16_compare_signed be16_compare_signed
+#define ne32_compare_signed be32_compare_signed
+#define ne64_compare_signed be64_compare_signed
+#else
+typedef LE16 NE16;
+typedef LE32 NE32;
+typedef LE64 NE64;
+#define ne16_compare le16_compare
+#define ne32_compare le32_compare
+#define ne64_compare le64_compare
+#define ne16_compare_signed le16_compare_signed
+#define ne32_compare_signed le32_compare_signed
+#define ne64_compare_signed le64_compare_signed
+#endif
+
+// <type_traits> upx_is_integral
+#define TT_IS_INTEGRAL(T)                                                                          \
+    template <>                                                                                    \
+    struct upx_is_integral<T> : public std::true_type {};                                          \
+    template <>                                                                                    \
+    struct upx_is_integral<const T> : public std::true_type {};                                    \
+    template <>                                                                                    \
+    struct upx_is_integral<volatile T> : public std::true_type {};                                 \
+    template <>                                                                                    \
+    struct upx_is_integral<const volatile T> : public std::true_type {}
+TT_IS_INTEGRAL(BE16);
+TT_IS_INTEGRAL(BE32);
+TT_IS_INTEGRAL(BE64);
+TT_IS_INTEGRAL(LE16);
+TT_IS_INTEGRAL(LE32);
+TT_IS_INTEGRAL(LE64);
+#undef TT_IS_INTEGRAL
+
 // for use with qsort()
-int be16_compare(const void *e1, const void *e2);
-int be32_compare(const void *e1, const void *e2);
-int le16_compare(const void *e1, const void *e2);
-int le32_compare(const void *e1, const void *e2);
+extern "C" {
+int __acc_cdecl_qsort be16_compare(const void *, const void *);
+int __acc_cdecl_qsort be24_compare(const void *, const void *);
+int __acc_cdecl_qsort be32_compare(const void *, const void *);
+int __acc_cdecl_qsort be64_compare(const void *, const void *);
+int __acc_cdecl_qsort le16_compare(const void *, const void *);
+int __acc_cdecl_qsort le24_compare(const void *, const void *);
+int __acc_cdecl_qsort le32_compare(const void *, const void *);
+int __acc_cdecl_qsort le64_compare(const void *, const void *);
+int __acc_cdecl_qsort be16_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort be24_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort be32_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort be64_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort le16_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort le24_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort le32_compare_signed(const void *, const void *);
+int __acc_cdecl_qsort le64_compare_signed(const void *, const void *);
+} // extern "C"
 
+/*************************************************************************
+// Provide namespaces and classes to abstract endianness policies.
+//
+// CTP - Compile-Time Polymorphism (templates)
+// RTP - Run-Time Polymorphism (virtual functions)
+**************************************************************************/
 
-#endif /* already included */
+// forward declarations
+namespace N_BELE_CTP {
+struct BEPolicy;
+struct LEPolicy;
+extern const BEPolicy be_policy;
+extern const LEPolicy le_policy;
+} // namespace N_BELE_CTP
+namespace N_BELE_RTP {
+struct AbstractPolicy;
+struct BEPolicy;
+struct LEPolicy;
+extern const BEPolicy be_policy;
+extern const LEPolicy le_policy;
+} // namespace N_BELE_RTP
 
+// implementation
+namespace N_BELE_CTP {
+#define BELE_CTP 1
+#include "bele_policy.h"
+#undef BELE_CTP
+} // namespace N_BELE_CTP
+namespace N_BELE_RTP {
+#define BELE_RTP 1
+#include "bele_policy.h"
+#undef BELE_RTP
+} // namespace N_BELE_RTP
 
-/*
-vi:ts=4:et:nowrap
-*/
+// util
+namespace N_BELE_CTP {
+inline const N_BELE_RTP::AbstractPolicy *getRTP(const BEPolicy * /*dummy*/) noexcept {
+    return &N_BELE_RTP::be_policy;
+}
+inline const N_BELE_RTP::AbstractPolicy *getRTP(const LEPolicy * /*dummy*/) noexcept {
+    return &N_BELE_RTP::le_policy;
+}
+} // namespace N_BELE_CTP
 
+/* vim:set ts=4 sw=4 et: */

src/bele_policy.h

@@ -0,0 +1,235 @@
+/* bele_policy.h -- access memory in BigEndian and LittleEndian byte order
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer              Laszlo Molnar
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
+ */
+
+// this is an internal include file private to bele.h
+
+/*************************************************************************
+//
+**************************************************************************/
+
+#if defined(BELE_CTP)
+// CTP - Compile-Time Polymorphism (templates)
+#define V static inline
+#define S static int __acc_cdecl_qsort
+#define C noexcept
+#elif defined(BELE_RTP)
+// RTP - Run-Time Polymorphism (virtual functions)
+#define V virtual
+#define S virtual int
+#define C const noexcept
+#else
+#error
+#endif
+
+#if defined(BELE_RTP)
+struct AbstractPolicy {
+    explicit inline AbstractPolicy() noexcept {}
+    virtual inline ~AbstractPolicy() noexcept {}
+    V bool isBE() C = 0;
+    V bool isLE() C = 0;
+
+    V unsigned get16(const void *p) C = 0;
+    V unsigned get24(const void *p) C = 0;
+    V unsigned get32(const void *p) C = 0;
+    V upx_uint64_t get64(const void *p) C = 0;
+
+    V void set16(void *p, unsigned v) C = 0;
+    V void set24(void *p, unsigned v) C = 0;
+    V void set32(void *p, unsigned v) C = 0;
+    V void set64(void *p, upx_uint64_t v) C = 0;
+
+    V int get16_signed(const void *p) C = 0;
+    V int get24_signed(const void *p) C = 0;
+    V int get32_signed(const void *p) C = 0;
+    V upx_int64_t get64_signed(const void *p) C = 0;
+
+    S u16_compare(const void *a, const void *b) C = 0;
+    S u24_compare(const void *a, const void *b) C = 0;
+    S u32_compare(const void *a, const void *b) C = 0;
+    S u64_compare(const void *a, const void *b) C = 0;
+
+    S u16_compare_signed(const void *a, const void *b) C = 0;
+    S u24_compare_signed(const void *a, const void *b) C = 0;
+    S u32_compare_signed(const void *a, const void *b) C = 0;
+    S u64_compare_signed(const void *a, const void *b) C = 0;
+
+private:
+    // disable copy and move
+    AbstractPolicy(const AbstractPolicy &) DELETED_FUNCTION;
+    AbstractPolicy &operator=(const AbstractPolicy &) DELETED_FUNCTION;
+    AbstractPolicy(AbstractPolicy &&) noexcept DELETED_FUNCTION;
+    AbstractPolicy &operator=(AbstractPolicy &&) noexcept DELETED_FUNCTION;
+    // disable dynamic allocation
+    ACC_CXX_DISABLE_NEW_DELETE
+};
+#endif
+
+#if defined(BELE_RTP)
+#undef C
+#define C const noexcept override
+#endif
+
+struct BEPolicy
+#if defined(BELE_RTP)
+    final : public AbstractPolicy
+#endif
+{
+    explicit inline BEPolicy() noexcept {}
+#if defined(BELE_CTP)
+    typedef N_BELE_RTP::BEPolicy RTP_Policy;
+#elif defined(BELE_RTP)
+    typedef N_BELE_CTP::BEPolicy CTP_Policy;
+#endif
+    V bool isBE() C { return true; }
+    V bool isLE() C { return false; }
+
+    typedef BE16 U16;
+    typedef BE32 U32;
+    typedef BE64 U64;
+
+    V unsigned get16(const void *p) C { return get_be16(p); }
+    V unsigned get24(const void *p) C { return get_be24(p); }
+    V unsigned get32(const void *p) C { return get_be32(p); }
+    V upx_uint64_t get64(const void *p) C { return get_be64(p); }
+
+    V void set16(void *p, unsigned v) C { set_be16(p, v); }
+    V void set24(void *p, unsigned v) C { set_be24(p, v); }
+    V void set32(void *p, unsigned v) C { set_be32(p, v); }
+    V void set64(void *p, upx_uint64_t v) C { set_be64(p, v); }
+
+    V int get16_signed(const void *p) C { return get_be16_signed(p); }
+    V int get24_signed(const void *p) C { return get_be24_signed(p); }
+    V int get32_signed(const void *p) C { return get_be32_signed(p); }
+    V upx_int64_t get64_signed(const void *p) C { return get_be64_signed(p); }
+
+    S u16_compare(const void *a, const void *b) C { return be16_compare(a, b); }
+    S u24_compare(const void *a, const void *b) C { return be24_compare(a, b); }
+    S u32_compare(const void *a, const void *b) C { return be32_compare(a, b); }
+    S u64_compare(const void *a, const void *b) C { return be64_compare(a, b); }
+
+    S u16_compare_signed(const void *a, const void *b) C { return be16_compare_signed(a, b); }
+    S u24_compare_signed(const void *a, const void *b) C { return be24_compare_signed(a, b); }
+    S u32_compare_signed(const void *a, const void *b) C { return be32_compare_signed(a, b); }
+    S u64_compare_signed(const void *a, const void *b) C { return be64_compare_signed(a, b); }
+
+    static void compileTimeAssertions() {
+        COMPILE_TIME_ASSERT(sizeof(U16) == 2)
+        COMPILE_TIME_ASSERT(sizeof(U32) == 4)
+        COMPILE_TIME_ASSERT(sizeof(U64) == 8)
+        COMPILE_TIME_ASSERT_ALIGNED1(U16)
+        COMPILE_TIME_ASSERT_ALIGNED1(U32)
+        COMPILE_TIME_ASSERT_ALIGNED1(U64)
+    }
+
+private:
+    // disable copy and move
+    BEPolicy(const BEPolicy &) DELETED_FUNCTION;
+    BEPolicy &operator=(const BEPolicy &) DELETED_FUNCTION;
+    BEPolicy(BEPolicy &&) noexcept DELETED_FUNCTION;
+    BEPolicy &operator=(BEPolicy &&) noexcept DELETED_FUNCTION;
+    // disable dynamic allocation
+    ACC_CXX_DISABLE_NEW_DELETE
+};
+
+struct LEPolicy
+#if defined(BELE_RTP)
+    final : public AbstractPolicy
+#endif
+{
+    explicit inline LEPolicy() noexcept {}
+#if defined(BELE_CTP)
+    typedef N_BELE_RTP::LEPolicy RTP_Policy;
+#elif defined(BELE_RTP)
+    typedef N_BELE_CTP::LEPolicy CTP_Policy;
+#endif
+    V bool isBE() C { return false; }
+    V bool isLE() C { return true; }
+
+    typedef LE16 U16;
+    typedef LE32 U32;
+    typedef LE64 U64;
+
+    V unsigned get16(const void *p) C { return get_le16(p); }
+    V unsigned get24(const void *p) C { return get_le24(p); }
+    V unsigned get32(const void *p) C { return get_le32(p); }
+    V upx_uint64_t get64(const void *p) C { return get_le64(p); }
+
+    V void set16(void *p, unsigned v) C { set_le16(p, v); }
+    V void set24(void *p, unsigned v) C { set_le24(p, v); }
+    V void set32(void *p, unsigned v) C { set_le32(p, v); }
+    V void set64(void *p, upx_uint64_t v) C { set_le64(p, v); }
+
+    V int get16_signed(const void *p) C { return get_le16_signed(p); }
+    V int get24_signed(const void *p) C { return get_le24_signed(p); }
+    V int get32_signed(const void *p) C { return get_le32_signed(p); }
+    V upx_int64_t get64_signed(const void *p) C { return get_le64_signed(p); }
+
+    S u16_compare(const void *a, const void *b) C { return le16_compare(a, b); }
+    S u24_compare(const void *a, const void *b) C { return le24_compare(a, b); }
+    S u32_compare(const void *a, const void *b) C { return le32_compare(a, b); }
+    S u64_compare(const void *a, const void *b) C { return le64_compare(a, b); }
+
+    S u16_compare_signed(const void *a, const void *b) C { return le16_compare_signed(a, b); }
+    S u24_compare_signed(const void *a, const void *b) C { return le24_compare_signed(a, b); }
+    S u32_compare_signed(const void *a, const void *b) C { return le32_compare_signed(a, b); }
+    S u64_compare_signed(const void *a, const void *b) C { return le64_compare_signed(a, b); }
+
+    static void compileTimeAssertions() {
+        COMPILE_TIME_ASSERT(sizeof(U16) == 2)
+        COMPILE_TIME_ASSERT(sizeof(U32) == 4)
+        COMPILE_TIME_ASSERT(sizeof(U64) == 8)
+        COMPILE_TIME_ASSERT_ALIGNED1(U16)
+        COMPILE_TIME_ASSERT_ALIGNED1(U32)
+        COMPILE_TIME_ASSERT_ALIGNED1(U64)
+    }
+
+private:
+    // disable copy and move
+    LEPolicy(const LEPolicy &) DELETED_FUNCTION;
+    LEPolicy &operator=(const LEPolicy &) DELETED_FUNCTION;
+    LEPolicy(LEPolicy &&) noexcept DELETED_FUNCTION;
+    LEPolicy &operator=(LEPolicy &&) noexcept DELETED_FUNCTION;
+    // disable dynamic allocation
+    ACC_CXX_DISABLE_NEW_DELETE
+};
+
+// Native Endianness policy (aka host policy)
+#if (ACC_ABI_BIG_ENDIAN)
+typedef BEPolicy NEPolicy;
+typedef BEPolicy HostPolicy;
+#elif (ACC_ABI_LITTLE_ENDIAN)
+typedef LEPolicy NEPolicy;
+typedef LEPolicy HostPolicy;
+#else
+#error "ACC_ABI_ENDIAN"
+#endif
+
+#undef V
+#undef S
+#undef C
+
+/* vim:set ts=4 sw=4 et: */

src/check/dt_check.cpp

@@ -0,0 +1,678 @@
+/* dt_check.cpp -- doctest check
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+
+/*************************************************************************
+// upx_doctest_check()
+//
+// honors environment variables:
+//   UPX_DEBUG_DOCTEST_DISABLE
+//   UPX_DEBUG_DOCTEST_VERBOSE
+//
+// HINT: set "UPX_DEBUG_DOCTEST_DISABLE=1" for improved debugging experience
+**************************************************************************/
+
+int upx_doctest_check(int argc, char **argv) {
+#if defined(DOCTEST_CONFIG_DISABLE)
+    UNUSED(argc);
+    UNUSED(argv);
+    return 0;
+#else
+    const char *e = getenv("UPX_DEBUG_DOCTEST_DISABLE");
+    if (e && e[0] && strcmp(e, "0") != 0)
+        return 0;
+    bool minimal = true;   // don't show summary
+    bool duration = false; // don't show timings
+    bool success = false;  // don't show all succeeding tests
+#if DEBUG
+    // default for debug builds: do show the [doctest] summary
+    minimal = false;
+#endif
+    e = getenv("UPX_DEBUG_DOCTEST_VERBOSE");
+    if (e && e[0]) {
+        if (strcmp(e, "0") == 0) {
+            minimal = true;
+        } else if (strcmp(e, "1") == 0) {
+            minimal = false;
+        } else if (strcmp(e, "2") == 0) {
+            minimal = false;
+            duration = true;
+        } else if (strcmp(e, "3") == 0) {
+            minimal = false;
+            duration = true;
+            success = true;
+        }
+    }
+    doctest::Context context;
+    if (minimal)
+        context.setOption("dt-minimal", true);
+    if (duration)
+        context.setOption("dt-duration", true);
+    if (success)
+        context.setOption("dt-success", true);
+    // this requires that main_get_options() understands "--dt-XXX" options
+    if (argc > 0 && argv != nullptr)
+        context.applyCommandLine(argc, argv);
+    int r = context.run();
+    if (r != 0)
+        return 1;
+    if (context.shouldExit())
+        return 2;
+    return 0;
+#endif // DOCTEST_CONFIG_DISABLE
+}
+
+int upx_doctest_check() { return upx_doctest_check(0, nullptr); }
+
+/*************************************************************************
+// compile-time checks
+**************************************************************************/
+
+// need extra parenthesis because the C preprocessor does not understand C++ templates
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<short, upx_int16_t>::value))
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<unsigned short, upx_uint16_t>::value))
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<int, upx_int32_t>::value))
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<unsigned, upx_uint32_t>::value))
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<long long, upx_int64_t>::value))
+ACC_COMPILE_TIME_ASSERT_HEADER((std::is_same<unsigned long long, upx_uint64_t>::value))
+
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_all_v<int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_all_v<int, int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_all_v<int, int, int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_all_v<int, char>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_all_v<int, char, int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_all_v<int, int, char>) )
+
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_any_v<int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_any_v<int, int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_any_v<int, char, int>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((is_same_any_v<int, int, char>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_any_v<int, char>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_any_v<int, char, char>) )
+ACC_COMPILE_TIME_ASSERT_HEADER((!is_same_any_v<int, char, long>) )
+
+ACC_COMPILE_TIME_ASSERT_HEADER(no_bswap16(0x04030201) == 0x0201)
+ACC_COMPILE_TIME_ASSERT_HEADER(no_bswap32(0x04030201) == 0x04030201)
+ACC_COMPILE_TIME_ASSERT_HEADER(no_bswap64(0x0807060504030201ull) == 0x0807060504030201ull)
+#if !(ACC_CC_MSC) // unfortunately *not* constexpr with current MSVC
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap16(0x04030201) == 0x0102)
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap32(0x04030201) == 0x01020304)
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap64(0x0807060504030201ull) == 0x0102030405060708ull)
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap16(bswap16(0xf4f3f2f1)) == no_bswap16(0xf4f3f2f1))
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap32(bswap32(0xf4f3f2f1)) == no_bswap32(0xf4f3f2f1))
+ACC_COMPILE_TIME_ASSERT_HEADER(bswap64(bswap64(0xf8f7f6f5f4f3f2f1ull)) ==
+                               no_bswap64(0xf8f7f6f5f4f3f2f1ull))
+#endif
+
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(int) == sizeof(int))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof('a') == sizeof(char))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof("") == 1)
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof("a") == 2)
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(0) == sizeof(int))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(0L) == sizeof(long))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(0LL) == sizeof(long long))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(nullptr) == sizeof(void *))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(sizeof(0)) == sizeof(size_t))
+ACC_COMPILE_TIME_ASSERT_HEADER(usizeof(usizeof(0)) == sizeof(unsigned))
+
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_len("") == 0)
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_len("a") == 1)
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_len("ab") == 2)
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_len("abc") == 3)
+
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_eq("", ""))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_eq("a", ""))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_eq("", "a"))
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_eq("abc", "abc"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_eq("ab", "abc"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_eq("abc", "ab"))
+
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_lt("", ""))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_lt("a", ""))
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_lt("", "a"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_lt("abc", "abc"))
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_lt("ab", "abc"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_lt("abc", "ab"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_lt("abc", "aba"))
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_lt("abc", "abz"))
+
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_ne("abc", "abz"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_gt("abc", "abz"))
+ACC_COMPILE_TIME_ASSERT_HEADER(!compile_time::string_ge("abc", "abz"))
+ACC_COMPILE_TIME_ASSERT_HEADER(compile_time::string_le("abc", "abz"))
+
+ACC_COMPILE_TIME_ASSERT_HEADER(CHAR_BIT == 8)
+#if 0 // does not work with MSVC
+#if '\0' - 1 < 0
+ACC_COMPILE_TIME_ASSERT_HEADER(CHAR_MAX == 127)
+#else
+ACC_COMPILE_TIME_ASSERT_HEADER(CHAR_MAX == 255)
+#endif
+#if L'\0' - 1 < 0
+ACC_COMPILE_TIME_ASSERT_HEADER((wchar_t) -1 < 0)
+#else
+ACC_COMPILE_TIME_ASSERT_HEADER((wchar_t) -1 > 0)
+#endif
+#endif
+
+/*************************************************************************
+// upx_compiler_sanity_check()
+// assert a sane architecture and compiler
+// (modern compilers will optimize away most of this code)
+**************************************************************************/
+
+namespace {
+
+template <class T>
+struct CheckIntegral {
+    struct TestT {
+        T a;
+        T x[2];
+    };
+    template <class U>
+    struct TestU {
+        U a = {};
+        const U b = {};
+        static constexpr U c = {};
+        U x[2] = {};
+        const U y[2] = {};
+        static constexpr U z[2] = {};
+    };
+    template <class U>
+    static void checkU(void) noexcept {
+        {
+            U a = {};
+            const U b = {};
+            constexpr U c = {};
+            U x[2] = {};
+            const U y[2] = {};
+            constexpr U z[2] = {};
+            assert_noexcept(a == 0);
+            assert_noexcept(b == 0);
+            assert_noexcept(c == 0);
+            assert_noexcept(x[0] == 0 && x[1] == 0);
+            assert_noexcept(y[0] == 0 && y[1] == 0);
+            assert_noexcept(z[0] == 0 && z[1] == 0);
+        }
+        {
+            TestU<U> t;
+            assert_noexcept(t.a == 0);
+            assert_noexcept(t.b == 0);
+            assert_noexcept(t.c == 0);
+            assert_noexcept(t.x[0] == 0 && t.x[1] == 0);
+            assert_noexcept(t.y[0] == 0 && t.y[1] == 0);
+            assert_noexcept(t.z[0] == 0 && t.z[1] == 0);
+        }
+#if __cplusplus < 202002L
+        COMPILE_TIME_ASSERT(std::is_pod<U>::value) // std::is_pod is deprecated in C++20
+#endif
+        COMPILE_TIME_ASSERT(std::is_standard_layout<U>::value)
+        COMPILE_TIME_ASSERT(std::is_trivial<U>::value)
+        // more checks, these are probably implied by std::is_trivial
+        COMPILE_TIME_ASSERT(std::is_nothrow_default_constructible<U>::value)
+        COMPILE_TIME_ASSERT(std::is_nothrow_destructible<U>::value)
+        COMPILE_TIME_ASSERT(std::is_trivially_copyable<U>::value)
+        COMPILE_TIME_ASSERT(std::is_trivially_default_constructible<U>::value)
+        // UPX extras
+        COMPILE_TIME_ASSERT(upx_is_integral<U>::value)
+        COMPILE_TIME_ASSERT(upx_is_integral_v<U>)
+    }
+    static void check(void) noexcept {
+        {
+            TestT t = {};
+            assert_noexcept(t.a == 0);
+            assert_noexcept(t.x[0] == 0 && t.x[1] == 0);
+        }
+        {
+            const TestT t = {};
+            assert_noexcept(t.a == 0);
+            assert_noexcept(t.x[0] == 0 && t.x[1] == 0);
+        }
+        {
+            constexpr TestT t = {};
+            assert_noexcept(t.a == 0);
+            assert_noexcept(t.x[0] == 0 && t.x[1] == 0);
+        }
+        {
+            TestT t;
+            mem_clear(&t);
+            assert_noexcept(t.a == 0);
+            assert_noexcept(t.x[0] == 0 && t.x[1] == 0);
+        }
+        checkU<T>();
+        checkU<typename std::add_const<T>::type>();
+    }
+};
+template <class T>
+struct CheckAlignment {
+    static void check(void) noexcept {
+        COMPILE_TIME_ASSERT_ALIGNED1(T)
+        struct alignas(1) Test1 {
+            char a;
+            T b;
+        };
+        struct alignas(1) Test2 {
+            char a;
+            T b[3];
+        };
+        COMPILE_TIME_ASSERT_ALIGNED1(Test1)
+        COMPILE_TIME_ASSERT_ALIGNED1(Test2)
+        Test1 t1[7];
+        Test2 t2[7];
+        COMPILE_TIME_ASSERT(sizeof(Test1) == 1 + sizeof(T))
+        COMPILE_TIME_ASSERT(sizeof(t1) == 7 + 7 * sizeof(T))
+        COMPILE_TIME_ASSERT(sizeof(Test2) == 1 + 3 * sizeof(T))
+        COMPILE_TIME_ASSERT(sizeof(t2) == 7 + 21 * sizeof(T))
+        UNUSED(t1);
+        UNUSED(t2);
+    }
+};
+template <class T>
+struct TestBELE {
+    static noinline bool test(void) noexcept {
+        CheckIntegral<T>::check();
+        CheckAlignment<T>::check();
+        // arithmetic checks
+        T allbits = {};
+        assert_noexcept(allbits == 0);
+        allbits += 1;
+        allbits -= 2;
+        T v1;
+        v1 = 1;
+        v1 *= 4;
+        v1 /= 2;
+        v1 -= 1;
+        T v2;
+        v2 = 1;
+        assert_noexcept((v1 == v2));
+        assert_noexcept(!(v1 != v2));
+        assert_noexcept((v1 <= v2));
+        assert_noexcept((v1 >= v2));
+        assert_noexcept(!(v1 < v2));
+        assert_noexcept(!(v1 > v2));
+        v2 ^= allbits;
+        assert_noexcept(!(v1 == v2));
+        assert_noexcept((v1 != v2));
+        assert_noexcept((v1 <= v2));
+        assert_noexcept(!(v1 >= v2));
+        assert_noexcept((v1 < v2));
+        assert_noexcept(!(v1 > v2));
+        v2 += 2;
+        assert_noexcept(v1 == 1);
+        assert_noexcept(v2 == 0);
+        v1 <<= 1;
+        v1 |= v2;
+        v1 >>= 1;
+        v2 &= v1;
+        v2 /= v1;
+        v2 *= v1;
+        v1 += v2;
+        v1 -= v2;
+        assert_noexcept(v1 == 1);
+        assert_noexcept(v2 == 0);
+        if ((v1 ^ v2) != 1)
+            return false;
+        return true;
+    }
+};
+
+template <class A, class B>
+struct TestNoAliasingStruct {
+    static noinline bool test(A *a, B *b) noexcept {
+        *a = 0;
+        *b = 0;
+        *b -= 3;
+        return *a != 0;
+    }
+};
+template <class A, class B>
+static forceinline bool testNoAliasing(A *a, B *b) noexcept {
+    return TestNoAliasingStruct<A, B>::test(a, b);
+}
+template <class T>
+struct TestIntegerWrap {
+    static inline bool inc_gt(const T x) noexcept { return x + 1 > x; }
+    static inline bool dec_lt(const T x) noexcept { return x - 1 < x; }
+    static inline bool neg_eq(const T x) noexcept { return T(0) - x == x; }
+};
+
+static noinline void throwSomeValue(int x) {
+    if (x < 0)
+        throw int(x);
+    else
+        throw size_t(x);
+}
+
+static noinline void check_basic_cxx_exception_handling(void (*func)(int)) noexcept {
+    bool cxx_exception_handling_works = false;
+    try {
+        func(42);
+    } catch (const size_t &e) {
+        if (e == 42)
+            cxx_exception_handling_works = true;
+    } catch (...) {
+    }
+    assert_noexcept(cxx_exception_handling_works);
+}
+
+} // namespace
+
+#define ACC_WANT_ACC_CHK_CH 1
+#undef ACCCHK_ASSERT
+#include "../miniacc.h"
+
+void upx_compiler_sanity_check(void) noexcept {
+    const char *e = getenv("UPX_DEBUG_DOCTEST_DISABLE");
+    if (e && e[0] && strcmp(e, "0") != 0) {
+        // If UPX_DEBUG_DOCTEST_DISABLE is set then we don't want to throw any
+        // exceptions in order to improve debugging experience.
+    } else {
+        // check working C++ exception handling to catch toolchain/qemu/wine/etc problems
+        check_basic_cxx_exception_handling(throwSomeValue);
+    }
+
+#define ACC_WANT_ACC_CHK_CH 1
+#undef ACCCHK_ASSERT
+#define ACCCHK_ASSERT(expr) ACC_COMPILE_TIME_ASSERT(expr)
+#include "../miniacc.h"
+#undef ACCCHK_ASSERT
+
+    COMPILE_TIME_ASSERT(sizeof(char) == 1)
+    COMPILE_TIME_ASSERT(sizeof(short) == 2)
+    COMPILE_TIME_ASSERT(sizeof(int) == 4)
+    COMPILE_TIME_ASSERT(sizeof(long) >= 4)
+    COMPILE_TIME_ASSERT(sizeof(void *) >= 4)
+
+    COMPILE_TIME_ASSERT(sizeof(BE16) == 2)
+    COMPILE_TIME_ASSERT(sizeof(BE32) == 4)
+    COMPILE_TIME_ASSERT(sizeof(BE64) == 8)
+    COMPILE_TIME_ASSERT(sizeof(LE16) == 2)
+    COMPILE_TIME_ASSERT(sizeof(LE32) == 4)
+    COMPILE_TIME_ASSERT(sizeof(LE64) == 8)
+
+    COMPILE_TIME_ASSERT_ALIGNED1(BE16)
+    COMPILE_TIME_ASSERT_ALIGNED1(BE32)
+    COMPILE_TIME_ASSERT_ALIGNED1(BE64)
+    COMPILE_TIME_ASSERT_ALIGNED1(LE16)
+    COMPILE_TIME_ASSERT_ALIGNED1(LE32)
+    COMPILE_TIME_ASSERT_ALIGNED1(LE64)
+
+    CheckIntegral<char>::check();
+    CheckIntegral<signed char>::check();
+    CheckIntegral<unsigned char>::check();
+    CheckIntegral<short>::check();
+    CheckIntegral<int>::check();
+    CheckIntegral<long>::check();
+    CheckIntegral<long long>::check();
+    CheckIntegral<ptrdiff_t>::check();
+    CheckIntegral<size_t>::check();
+    CheckIntegral<upx_off_t>::check();
+    CheckIntegral<upx_uintptr_t>::check();
+
+    COMPILE_TIME_ASSERT(sizeof(upx_charptr_unit_type) == 1)
+    COMPILE_TIME_ASSERT_ALIGNED1(upx_charptr_unit_type)
+    COMPILE_TIME_ASSERT(sizeof(*((charptr) nullptr)) == 1)
+
+    COMPILE_TIME_ASSERT(sizeof(UPX_VERSION_STRING4) == 4 + 1)
+    assert_noexcept(strlen(UPX_VERSION_STRING4) == 4);
+    COMPILE_TIME_ASSERT(sizeof(UPX_VERSION_YEAR) == 4 + 1)
+    assert_noexcept(strlen(UPX_VERSION_YEAR) == 4);
+    assert_noexcept(memcmp(UPX_VERSION_DATE_ISO, UPX_VERSION_YEAR, 4) == 0);
+    assert_noexcept(
+        memcmp(&UPX_VERSION_DATE[sizeof(UPX_VERSION_DATE) - 1 - 4], UPX_VERSION_YEAR, 4) == 0);
+    if (gitrev[0]) {
+        size_t revlen = strlen(gitrev);
+        if (strncmp(gitrev, "ERROR", 5) == 0) {
+            assert_noexcept(revlen == 5 || revlen == 6);
+        } else {
+            assert_noexcept(revlen == 12 || revlen == 13);
+        }
+        if (revlen == 6 || revlen == 13) {
+            assert_noexcept(gitrev[revlen - 1] == '+');
+        }
+    }
+    assert_noexcept(UPX_RSIZE_MAX_MEM == 805306368);
+
+#if DEBUG || 1
+    assert_noexcept(TestBELE<LE16>::test());
+    assert_noexcept(TestBELE<LE32>::test());
+    assert_noexcept(TestBELE<LE64>::test());
+    assert_noexcept(TestBELE<BE16>::test());
+    assert_noexcept(TestBELE<BE32>::test());
+    assert_noexcept(TestBELE<BE64>::test());
+    {
+        alignas(16) static const byte dd[32] = {
+            0, 0, 0, 0,    0,    0,    0,    0xff, 0xfe, 0xfd, 0xfc, 0xfb, 0xfa, 0xf9, 0xf8, 0,
+            0, 0, 0, 0x7f, 0x7e, 0x7d, 0x7c, 0x7b, 0x7a, 0x79, 0x78, 0,    0,    0,    0,    0};
+        const byte *d;
+        const N_BELE_RTP::AbstractPolicy *bele;
+        d = dd + 7;
+        assert_noexcept(upx_adler32(d, 4) == 0x09f003f7);
+        assert_noexcept(upx_adler32(d, 4, 0) == 0x09ec03f6);
+        assert_noexcept(upx_adler32(d, 4, 1) == 0x09f003f7);
+        bele = &N_BELE_RTP::be_policy;
+        assert_noexcept(get_be16(d) == 0xfffe);
+        assert_noexcept(bele->get16(d) == 0xfffe);
+        assert_noexcept(get_be16_signed(d) == -2);
+        assert_noexcept(get_be24(d) == 0xfffefd);
+        assert_noexcept(bele->get24(d) == 0xfffefd);
+        assert_noexcept(get_be24_signed(d) == -259);
+        assert_noexcept(get_be32(d) == 0xfffefdfc);
+        assert_noexcept(bele->get32(d) == 0xfffefdfc);
+        assert_noexcept(get_be32_signed(d) == -66052);
+        bele = &N_BELE_RTP::le_policy;
+        assert_noexcept(get_le16(d) == 0xfeff);
+        assert_noexcept(bele->get16(d) == 0xfeff);
+        assert_noexcept(get_le16_signed(d) == -257);
+        assert_noexcept(get_le24(d) == 0xfdfeff);
+        assert_noexcept(bele->get24(d) == 0xfdfeff);
+        assert_noexcept(get_le24_signed(d) == -131329);
+        assert_noexcept(get_le32(d) == 0xfcfdfeff);
+        assert_noexcept(bele->get32(d) == 0xfcfdfeff);
+        assert_noexcept(get_le32_signed(d) == -50462977);
+        assert_noexcept(get_le64_signed(d) == -506097522914230529LL);
+        assert_noexcept(find_be16(d, 2, 0xfffe) == 0);
+        assert_noexcept(find_le16(d, 2, 0xfeff) == 0);
+        assert_noexcept(find_be32(d, 4, 0xfffefdfc) == 0);
+        assert_noexcept(find_le32(d, 4, 0xfcfdfeff) == 0);
+        d += 12;
+        assert_noexcept(get_be16_signed(d) == 32638);
+        assert_noexcept(get_be24_signed(d) == 8355453);
+        assert_noexcept(get_be32_signed(d) == 2138996092);
+        assert_noexcept(get_be64_signed(d) == 9186918263483431288LL);
+    }
+    {
+        unsigned dd;
+        void *const d = &dd;
+        dd = ne32_to_le32(0xf7f6f5f4);
+        assert_noexcept(get_le26(d) == 0x03f6f5f4);
+        set_le26(d, 0);
+        assert_noexcept(get_le26(d) == 0);
+        assert_noexcept(dd == ne32_to_le32(0xf4000000));
+        set_le26(d, 0xff020304);
+        assert_noexcept(get_le26(d) == 0x03020304);
+        assert_noexcept(dd == ne32_to_le32(0xf7020304));
+    }
+    {
+        upx_uint16_t a = 0;
+        upx_uint32_t b = 0;
+        upx_uint64_t c = 0;
+        set_ne16(&a, 0x04030201); // ignore upper bits
+        set_ne32(&b, 0x04030201);
+        set_ne64(&c, 0x0807060504030201ull);
+        assert_noexcept(a == 0x0201);
+        assert_noexcept(b == 0x04030201);
+        assert_noexcept(c == 0x0807060504030201ull);
+        assert_noexcept(get_ne16(&a) == 0x0201);
+        assert_noexcept(get_ne32(&b) == 0x04030201);
+        assert_noexcept(get_ne64(&c) == 0x0807060504030201ull);
+    }
+#endif // DEBUG
+    union {
+        short v_short;
+        int v_int;
+        long v_long;
+        long long v_llong;
+        BE16 b16;
+        BE32 b32;
+        BE64 b64;
+        LE16 l16;
+        LE32 l32;
+        LE64 l64;
+    } u;
+    assert_noexcept(testNoAliasing(&u.v_short, &u.b32));
+    assert_noexcept(testNoAliasing(&u.v_short, &u.l32));
+    assert_noexcept(testNoAliasing(&u.v_int, &u.b64));
+    assert_noexcept(testNoAliasing(&u.v_int, &u.l64));
+    // check working -fno-strict-aliasing
+    assert_noexcept(testNoAliasing(&u.v_short, &u.v_int));
+    assert_noexcept(testNoAliasing(&u.v_int, &u.v_long));
+    assert_noexcept(testNoAliasing(&u.v_int, &u.v_llong));
+    assert_noexcept(testNoAliasing(&u.v_long, &u.v_llong));
+
+    assert_noexcept(TestIntegerWrap<unsigned>::inc_gt(0));
+    assert_noexcept(!TestIntegerWrap<unsigned>::inc_gt(UINT_MAX));
+    assert_noexcept(TestIntegerWrap<unsigned>::dec_lt(1));
+    assert_noexcept(!TestIntegerWrap<unsigned>::dec_lt(0));
+    assert_noexcept(TestIntegerWrap<unsigned>::neg_eq(0));
+    assert_noexcept(!TestIntegerWrap<unsigned>::neg_eq(1));
+    assert_noexcept(!TestIntegerWrap<unsigned>::neg_eq(UINT_MAX));
+    // check working -fno-strict-overflow
+    assert_noexcept(TestIntegerWrap<int>::inc_gt(0));
+    assert_noexcept(!TestIntegerWrap<int>::inc_gt(INT_MAX));
+    assert_noexcept(TestIntegerWrap<int>::dec_lt(0));
+    assert_noexcept(!TestIntegerWrap<int>::dec_lt(INT_MIN));
+    assert_noexcept(TestIntegerWrap<int>::neg_eq(0));
+    assert_noexcept(!TestIntegerWrap<int>::neg_eq(1));
+    assert_noexcept(!TestIntegerWrap<int>::neg_eq(INT_MAX));
+    assert_noexcept(TestIntegerWrap<int>::neg_eq(INT_MIN)); // special case
+}
+
+/*************************************************************************
+// some doctest test cases
+**************************************************************************/
+
+TEST_CASE("assert_noexcept") {
+    // just to make sure that our own assert macros don't generate any warnings
+    byte dummy = 0;
+    byte *ptr1 = &dummy;
+    const byte *const ptr2 = &dummy;
+    void *ptr3 = nullptr;
+    assert(true);
+    assert(1);
+    assert(ptr1);
+    assert(ptr2);
+    assert(!ptr3);
+    assert_noexcept(true);
+    assert_noexcept(1);
+    assert_noexcept(ptr1);
+    assert_noexcept(ptr2);
+    assert_noexcept(!ptr3);
+}
+
+TEST_CASE("noncopyable") {
+    struct Test : private noncopyable {
+        int v = 1;
+    };
+    Test t = {};
+    CHECK(t.v == 1);
+#if (ACC_CC_MSC) // MSVC thinks that Test is not std::is_trivially_copyable; true or compiler bug?
+    t.v = 0;
+#else
+    mem_clear(&t);
+#endif
+    CHECK(t.v == 0);
+}
+
+TEST_CASE("acc_vget") {
+    CHECK_EQ(acc_vget_int(0, 0), 0);
+    CHECK_EQ(acc_vget_long(1, -1), 1);
+    CHECK_EQ(acc_vget_acc_int64l_t(2, 1), 2);
+    CHECK_EQ(acc_vget_acc_hvoid_p(nullptr, 0), nullptr);
+}
+
+TEST_CASE("working -fno-strict-aliasing") {
+    bool ok;
+    long v = 0;
+    short *ps = ACC_STATIC_CAST(short *, acc_vget_acc_hvoid_p(&v, 0));
+    int *pi = ACC_STATIC_CAST(int *, acc_vget_acc_hvoid_p(&v, 0));
+    long *pl = ACC_STATIC_CAST(long *, acc_vget_acc_hvoid_p(&v, 0));
+    *ps = 0;
+    *pl = -1;
+    ok = *ps == -1;
+    CHECK(ok);
+    *pi = 0;
+    *pl = -1;
+    ok = *pi == -1;
+    CHECK(ok);
+    *pl = 0;
+    *ps = -1;
+    ok = *pl != 0;
+    CHECK(ok);
+    *pl = 0;
+    *pi = -1;
+    ok = *pl != 0;
+    CHECK(ok);
+}
+
+TEST_CASE("working -fno-strict-overflow") {
+    CHECK_EQ(acc_vget_int(INT_MAX, 0) + 1, INT_MIN);
+    CHECK_EQ(acc_vget_int(INT_MIN, 0) - 1, INT_MAX);
+    CHECK_EQ(acc_vget_long(LONG_MAX, 0) + 1, LONG_MIN);
+    CHECK_EQ(acc_vget_long(LONG_MIN, 0) - 1, LONG_MAX);
+    bool ok;
+    int i;
+    i = INT_MAX;
+    i += 1;
+    ok = i == INT_MIN;
+    CHECK(ok);
+    i = INT_MIN;
+    i -= 1;
+    ok = i == INT_MAX;
+    CHECK(ok);
+}
+
+TEST_CASE("libc snprintf") {
+    // runtime check that Windows/MinGW <stdio.h> works as expected
+    char buf[64];
+    long long ll = acc_vget_int(-1, 0);
+    unsigned long long llu = (unsigned long long) ll;
+    snprintf(buf, sizeof(buf), "%d.%ld.%lld.%u.%lu.%llu", -3, -2L, ll, 3U, 2LU, llu);
+    CHECK_EQ(strcmp(buf, "-3.-2.-1.3.2.18446744073709551615"), 0);
+    intmax_t im = ll;
+    uintmax_t um = llu;
+    snprintf(buf, sizeof(buf), "%d.%d.%d.%d.%d.%d.%d.%d.%d.%jd", -4, 0, 0, 0, 0, 0, 0, 0, 4, im);
+    CHECK_EQ(strcmp(buf, "-4.0.0.0.0.0.0.0.4.-1"), 0);
+    snprintf(buf, sizeof(buf), "%d.%d.%d.%d.%d.%d.%d.%d.%d.%ju", -5, 0, 0, 0, 0, 0, 0, 0, 5, um);
+    CHECK_EQ(strcmp(buf, "-5.0.0.0.0.0.0.0.5.18446744073709551615"), 0);
+    snprintf(buf, sizeof(buf), "%d.%d.%d.%d.%d.%d.%d.%d.%d.%jx", -6, 0, 0, 0, 0, 0, 0, 0, 6, um);
+    CHECK_EQ(strcmp(buf, "-6.0.0.0.0.0.0.0.6.ffffffffffffffff"), 0);
+    snprintf(buf, sizeof(buf), "%d.%d.%d.%d.%d.%d.%d.%d.%d.%#jx", -7, 0, 0, 0, 0, 0, 0, 0, 7, um);
+    CHECK_EQ(strcmp(buf, "-7.0.0.0.0.0.0.0.7.0xffffffffffffffff"), 0);
+}
+
+/* vim:set ts=4 sw=4 et: */

src/check/dt_impl.cpp

@@ -0,0 +1,59 @@
+/* dt_impl.cpp -- doctest support code implementation
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+/*************************************************************************
+// doctest support code implementation
+**************************************************************************/
+
+#define DOCTEST_CONFIG_IMPLEMENT
+#define DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS
+
+#if !defined(DOCTEST_CONFIG_DISABLE)
+
+#if defined(__i386__) && defined(__MSDOS__) && defined(__DJGPP__) && defined(__GNUC__)
+#define DOCTEST_CONFIG_NO_MULTITHREADING
+#define DOCTEST_CONFIG_NO_POSIX_SIGNALS
+#elif defined(__m68k__) && defined(__atarist__) && defined(__GNUC__)
+#define DOCTEST_CONFIG_COLORS_NONE
+#define DOCTEST_CONFIG_NO_MULTITHREADING
+#define DOCTEST_CONFIG_NO_POSIX_SIGNALS
+#pragma GCC diagnostic ignored "-Wshadow"
+#endif
+
+#if !defined(UPX_DOCTEST_CONFIG_MULTITHREADING)
+#define DOCTEST_CONFIG_NO_MULTITHREADING
+#endif
+
+#if defined(__clang__) && defined(__FAST_MATH__) && defined(__INTEL_LLVM_COMPILER)
+// warning: comparison with NaN always evaluates to false in fast floating point modes
+#pragma clang diagnostic ignored "-Wtautological-constant-compare"
+#endif
+
+#include <doctest/doctest/parts/doctest.cpp>
+
+#endif // DOCTEST_CONFIG_DISABLE
+
+/* vim:set ts=4 sw=4 et: */

src/check/dt_xspan.cpp

@@ -0,0 +1,846 @@
+/* xspan -- a minimally invasive checked memory smart pointer
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+// lots of tests (and probably quite a number of redundant tests)
+
+#include "../conf.h"
+
+/*************************************************************************
+// raw_bytes
+**************************************************************************/
+
+TEST_CASE("raw_bytes ptr") {
+    upx_uint16_t *ptr = nullptr;
+    CHECK_NOTHROW(raw_bytes(ptr, 0));
+    CHECK_THROWS(raw_bytes(ptr, 1));
+    CHECK_THROWS(raw_index_bytes(ptr, 0, 0));
+    CHECK_THROWS(raw_index_bytes(ptr, 1, 0));
+    CHECK_THROWS(raw_index_bytes(ptr, 0, 1));
+    upx_uint16_t buf[4];
+    ptr = buf;
+    CHECK(ptr_udiff_bytes(raw_index_bytes(ptr, 1, 1), ptr) == 2u);
+    CHECK(ptr_udiff_bytes(raw_index_bytes(ptr, 4, 0), ptr) == 8u);
+}
+
+TEST_CASE("raw_bytes bounded array") {
+    upx_uint16_t buf[4];
+    CHECK_NOTHROW(raw_bytes(buf, 8));
+    CHECK_THROWS(raw_bytes(buf, 9));
+    CHECK_NOTHROW(raw_index_bytes(buf, 4, 0));
+    CHECK_THROWS(raw_index_bytes(buf, 4, 1));
+    CHECK_NOTHROW(raw_index_bytes(buf, 3, 2));
+    CHECK_THROWS(raw_index_bytes(buf, 3, 3));
+    CHECK(ptr_udiff_bytes(raw_index_bytes(buf, 1, 1), buf) == 2u);
+    CHECK(ptr_udiff_bytes(raw_index_bytes(buf, 4, 0), buf) == 8u);
+}
+
+/*************************************************************************
+// basic xspan
+**************************************************************************/
+
+TEST_CASE("basic xspan usage") {
+    char buf[4] = {0, 1, 2, 3};
+
+    SUBCASE("XSPAN_x") {
+        XSPAN_0(char) a0 = nullptr;
+
+        XSPAN_0(char) b0 = buf;
+        XSPAN_P(char) bp = buf;
+
+        XSPAN_0(char) c0 = XSPAN_0_MAKE(char, buf);
+        XSPAN_P(char) cp = XSPAN_P_MAKE(char, buf);
+        XSPAN_S(char) cs = XSPAN_S_MAKE(char, buf, sizeof(buf));
+
+        XSPAN_0(const char) const x0 = XSPAN_0_MAKE(const char, buf);
+        XSPAN_P(const char) const xp = XSPAN_P_MAKE(const char, buf);
+        XSPAN_S(const char) const xs = XSPAN_S_MAKE(const char, buf, sizeof(buf));
+        XSPAN_P(const char) const yp = xs;
+        XSPAN_0(const char) const z0p = yp;
+        XSPAN_0(const char) const z0s = xs;
+
+        CHECK((a0 == nullptr));
+        CHECK(c0 == b0);
+        CHECK(cp == bp);
+        CHECK(cs == bp);
+        CHECK(x0 == z0p);
+        CHECK(xp == z0s);
+
+        CHECK_NOTHROW(raw_bytes(a0, 0));
+        CHECK_THROWS(raw_bytes(a0, 1));
+        CHECK_THROWS(raw_index_bytes(a0, 0, 0));
+
+        CHECK(raw_bytes(b0, 0) == buf);
+        CHECK(raw_bytes(bp, 0) == buf);
+        // info: these will fail if we ever add an overload for bounded-arrays
+#if WITH_XSPAN >= 2
+        CHECK(b0.raw_size_in_bytes() == 0u);
+        CHECK(bp.raw_size_in_bytes() == 0u);
+#endif
+        CHECK(raw_bytes(b0, 999999) == buf);
+        CHECK(raw_bytes(bp, 999999) == buf);
+
+        CHECK(raw_bytes(c0, 4) == buf);
+        CHECK(raw_index_bytes(c0, 1, 3) == buf + 1);
+        CHECK(raw_bytes(cp, 4) == buf);
+        CHECK(raw_index_bytes(cp, 1, 3) == buf + 1);
+        CHECK(raw_bytes(cs, 4) == buf);
+        CHECK(raw_index_bytes(cs, 1, 3) == buf + 1);
+#if WITH_XSPAN >= 2
+        CHECK_THROWS(raw_bytes(cs, 5));
+        CHECK_THROWS(raw_index_bytes(cs, 1, 4));
+#endif
+    }
+
+    SUBCASE("XSPAN_x_VAR") {
+        XSPAN_0_VAR(char, b0, buf);
+        XSPAN_P_VAR(char, bp, buf);
+
+        XSPAN_0_VAR(char, c0, buf, sizeof(buf));
+        XSPAN_P_VAR(char, cp, buf, sizeof(buf));
+        XSPAN_S_VAR(char, cs, buf, sizeof(buf));
+
+        XSPAN_0_VAR(char, d0, buf + 1, sizeof(buf), buf);
+        XSPAN_P_VAR(char, dp, buf + 1, sizeof(buf), buf);
+        XSPAN_S_VAR(char, ds, buf + 1, sizeof(buf), buf);
+
+        XSPAN_0_VAR(const char, const x0, buf, sizeof(buf));
+        XSPAN_P_VAR(const char, const xp, buf, sizeof(buf));
+        XSPAN_S_VAR(const char, const xs, buf, sizeof(buf));
+        XSPAN_P_VAR(const char, const yp, xs);
+        XSPAN_0_VAR(const char, const z0p, yp);
+        XSPAN_0_VAR(const char, const z0s, xs);
+
+        CHECK(c0 == b0);
+        CHECK(cp == bp);
+        CHECK(cs == bp);
+        CHECK(d0 == dp);
+        CHECK(d0 == ds);
+        CHECK(x0 == z0p);
+        CHECK(xp == z0s);
+
+#if WITH_XSPAN >= 1 || __cplusplus >= 201103L
+        XSPAN_0_VAR(char, a0, nullptr);
+        CHECK((a0 == nullptr));
+        CHECK_NOTHROW(raw_bytes(a0, 0));
+        CHECK_THROWS(raw_bytes(a0, 1));
+        CHECK_THROWS(raw_index_bytes(a0, 0, 0));
+#endif
+
+        CHECK(raw_bytes(b0, 0) == buf);
+        CHECK(raw_bytes(bp, 0) == buf);
+        // info: these will fail if we ever add an overload for bounded-arrays
+#if WITH_XSPAN >= 2
+        CHECK(b0.raw_size_in_bytes() == 0u);
+        CHECK(bp.raw_size_in_bytes() == 0u);
+#endif
+        CHECK(raw_bytes(b0, 999999) == buf);
+        CHECK(raw_bytes(bp, 999999) == buf);
+
+        CHECK(raw_bytes(c0, 4) == buf);
+        CHECK(raw_index_bytes(c0, 1, 3) == buf + 1);
+        CHECK(raw_bytes(cp, 4) == buf);
+        CHECK(raw_index_bytes(cp, 1, 3) == buf + 1);
+        CHECK(raw_bytes(cs, 4) == buf);
+        CHECK(raw_index_bytes(cs, 1, 3) == buf + 1);
+#if WITH_XSPAN >= 2
+        CHECK_THROWS(raw_bytes(cs, 5));
+        CHECK_THROWS(raw_index_bytes(cs, 1, 4));
+#endif
+    }
+
+    SUBCASE("xspan in class") {
+        struct MyType {
+            XSPAN_0(char) s0;
+            XSPAN_P(char) sp;
+            XSPAN_S(char) ss;
+#if __cplusplus >= 201103L
+            XSPAN_0(char) x0 = nullptr;
+#endif
+#if WITH_XSPAN >= 2
+            // much nicer syntax when using fully checked xspan:
+            MyType(char *b, size_t n, bool) : s0(b, n), sp(b, n), ss(b, n) {}
+#endif
+            MyType(char *b, size_t n)
+                : s0(XSPAN_0_MAKE(char, b, n)), sp(XSPAN_P_MAKE(char, b, n)),
+                  ss(XSPAN_S_MAKE(char, b, n)) {
+                UNUSED(n);
+            }
+        };
+        MyType x(buf, sizeof(buf));
+        MyType y = MyType(buf, sizeof(buf));
+        CHECK(x.s0 == y.sp);
+    }
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+#if (WITH_XSPAN >= 2) && DEBUG
+
+TEST_CASE("PtrOrSpanOrNull") {
+    char real_buf[2 + 6 + 2] = {126, 127, 0, 1, 2, 3, 4, 5, 124, 125};
+    char *base_buf = real_buf + 2;
+    char *const my_null = nullptr;
+    typedef PtrOrSpanOrNull<char> Span0;
+
+    // basic nullptr
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf) = my_null);
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf).assign(my_null));
+    // basic range checking
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf));
+    CHECK_NOTHROW(Span0(base_buf, 0, base_buf));
+    CHECK_NOTHROW(Span0(base_buf, 0, base_buf) - 0);
+    CHECK_THROWS(Span0(base_buf, 0, base_buf) + 1);
+    CHECK_THROWS(Span0(base_buf, 0, base_buf) - 1);
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf) + 4);
+    CHECK_THROWS(Span0(base_buf, 4, base_buf) + 5);
+    CHECK_THROWS(Span0(base_buf - 1, 4, base_buf));
+    CHECK_THROWS(Span0(base_buf + 1, 0, base_buf));
+    // basic same base
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf) = Span0(base_buf + 1, 3, base_buf));
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf) = Span0(base_buf + 1, 1, base_buf));
+    CHECK_NOTHROW(Span0(base_buf, 4, base_buf) = Span0(base_buf + 1, 5, base_buf));
+    CHECK_THROWS(Span0(base_buf, 4, base_buf) = Span0(base_buf + 1, 3, base_buf + 1));
+
+    Span0 a1(nullptr);
+    assert(a1 == nullptr);
+    assert(a1.raw_ptr() == nullptr);
+    assert(a1.raw_base() == nullptr);
+    assert(a1.raw_size_in_bytes() == 0u);
+    CHECK_THROWS(*a1);
+    CHECK_THROWS(a1[0]);
+
+    Span0 a2 = nullptr;
+    assert(a2 == nullptr);
+    assert(a2.raw_ptr() == nullptr);
+    assert(a2.raw_base() == nullptr);
+    assert(a2.raw_size_in_bytes() == 0u);
+    CHECK_THROWS(*a2);
+    CHECK_THROWS(a2[0]);
+
+    Span0 base0(nullptr, 4, base_buf);
+    assert(base0.raw_ptr() == nullptr);
+    assert(base0.raw_base() == base_buf);
+    assert(base0.raw_size_in_bytes() == 4u);
+    CHECK_THROWS(*base0);    // nullptr
+    CHECK_THROWS(base0[0]);  // nullptr
+    CHECK_THROWS(base0 + 1); // nullptr
+
+    Span0 base4(base_buf, 4);
+    assert(base4.raw_ptr() == base_buf);
+    assert(base4.raw_base() == base_buf);
+    assert(base4.raw_size_in_bytes() == 4u);
+
+    a1 = base_buf;
+    a1 = base0;
+    assert(a1 == nullptr);
+    assert(a1.raw_ptr() == nullptr);
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+    a1 = base4;
+    assert(a1 == base_buf);
+    assert(a1.raw_ptr() == base_buf);
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+
+    a1 = base_buf;
+    assert(a1 != nullptr);
+    a1 = base_buf + 1;
+    CHECK(*a1++ == 1);
+    CHECK(*++a1 == 3);
+    CHECK(*a1 == 3);
+    a1 = base_buf + 4; // at the end of buffer
+    CHECK_THROWS(*a1);
+    CHECK_THROWS(a1 = base_buf + 5); // range error
+    assert(a1 == base_buf + 4);
+    CHECK(a1[-4] == 0);
+    CHECK_THROWS(a1[-5]); // range error
+    a1 = base_buf;
+    CHECK(*a1 == 0);
+
+    Span0 new_base4(base_buf + 2, 4);
+    CHECK_THROWS(a1 = new_base4); // not same base
+    a2 = new_base4;
+    CHECK_THROWS(a2 = base4); // not same base
+
+    Span0 s0_no_base(nullptr);
+    Span0 s0_with_base(nullptr, 4, base_buf);
+    s0_no_base = nullptr;
+    s0_with_base = nullptr;
+    s0_with_base = s0_no_base;
+    assert(s0_no_base.raw_base() == nullptr);
+    assert(s0_with_base.raw_base() == base_buf);
+    s0_no_base = s0_with_base;
+    assert(s0_no_base.raw_base() == base_buf);
+    assert(s0_no_base.raw_ptr() == nullptr);
+    assert(s0_with_base.raw_ptr() == nullptr);
+    s0_no_base = my_null;
+    s0_with_base = my_null;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+TEST_CASE("PtrOrSpan") {
+    char real_buf[2 + 6 + 2] = {126, 127, 0, 1, 2, 3, 4, 5, 124, 125};
+    char *base_buf = real_buf + 2;
+    char *const my_null = nullptr;
+    typedef PtrOrSpan<char> SpanP;
+
+    // basic nullptr
+    CHECK_THROWS(SpanP(base_buf, 4, base_buf) = my_null);
+    CHECK_THROWS(SpanP(base_buf, 4, base_buf).assign(my_null));
+    // basic range checking
+    CHECK_NOTHROW(SpanP(base_buf, 4, base_buf));
+    CHECK_NOTHROW(SpanP(base_buf, 0, base_buf));
+    CHECK_NOTHROW(SpanP(base_buf, 0, base_buf) - 0);
+    CHECK_THROWS(SpanP(base_buf, 0, base_buf) + 1);
+    CHECK_THROWS(SpanP(base_buf, 0, base_buf) - 1);
+    CHECK_NOTHROW(SpanP(base_buf, 4, base_buf) + 4);
+    CHECK_THROWS(SpanP(base_buf, 4, base_buf) + 5);
+    CHECK_THROWS(SpanP(base_buf - 1, 4, base_buf));
+    CHECK_THROWS(SpanP(base_buf + 1, 0, base_buf));
+    // basic same base
+    CHECK_NOTHROW(SpanP(base_buf, 4, base_buf) = SpanP(base_buf + 1, 3, base_buf));
+    CHECK_NOTHROW(SpanP(base_buf, 4, base_buf) = SpanP(base_buf + 1, 1, base_buf));
+    CHECK_NOTHROW(SpanP(base_buf, 4, base_buf) = SpanP(base_buf + 1, 5, base_buf));
+    CHECK_THROWS(SpanP(base_buf, 4, base_buf) = SpanP(base_buf + 1, 3, base_buf + 1));
+
+    SpanP x1(base_buf, 0);
+    assert(x1 != nullptr);
+    assert(x1.raw_ptr() == base_buf);
+    assert(x1.raw_base() == base_buf);
+    assert(x1.raw_size_in_bytes() == 0u);
+    CHECK_THROWS(*x1);
+    CHECK_THROWS(x1[0]);
+
+    SpanP a2 = base_buf;
+    assert(a2 != nullptr);
+    assert(a2.raw_ptr() == base_buf);
+    assert(a2.raw_base() == nullptr);
+    assert(a2.raw_size_in_bytes() == 0u);
+    CHECK(*a2 == 0);
+    CHECK(a2[1] == 1);
+
+    SpanP base0(base_buf, 4, base_buf);
+    assert(base0.raw_ptr() == base_buf);
+    assert(base0.raw_base() == base_buf);
+    assert(base0.raw_size_in_bytes() == 4u);
+
+    SpanP base4(base_buf, 4);
+    assert(base4.raw_ptr() == base_buf);
+    assert(base4.raw_base() == base_buf);
+    assert(base4.raw_size_in_bytes() == 4u);
+
+    SpanP a1(base_buf, 4);
+    a1 = base_buf;
+    a1 = base0;
+    assert(a1 == base0);
+    assert(a1 != nullptr);
+    assert(a1.raw_ptr() == base0.raw_ptr());
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+    a1 = base4;
+    assert(a1 == base_buf);
+    assert(a1.raw_ptr() == base_buf);
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+
+    a1 = base_buf;
+    a1 = base_buf + 1;
+    CHECK(*a1++ == 1);
+    CHECK(*++a1 == 3);
+    CHECK(*a1 == 3);
+    a1 = base_buf + 4; // at the end of buffer
+    CHECK_THROWS(*a1);
+    CHECK_THROWS(a1 = base_buf + 5); // range error
+    assert(a1 == base_buf + 4);
+    CHECK(a1[-4] == 0);
+    CHECK_THROWS(a1[-5]); // range error
+    a1 = base_buf;
+    CHECK(*a1 == 0);
+
+    SpanP new_base4(base_buf + 2, 4);
+    CHECK_THROWS(a1 = new_base4); // not same base
+    a2 = new_base4;
+    CHECK_THROWS(a2 = base4); // not same base
+
+    SpanP sp_no_base(base_buf);
+    SpanP sp_with_base(base_buf, 4, base_buf);
+    assert(sp_no_base.raw_base() == nullptr);
+    assert(sp_with_base.raw_base() == base_buf);
+    CHECK_THROWS(sp_no_base = my_null);   // nullptr assignment
+    CHECK_THROWS(sp_with_base = my_null); // nullptr assignment
+#if XSPAN_CONFIG_ENABLE_SPAN_CONVERSION
+    typedef PtrOrSpanOrNull<char> Span0;
+    Span0 s0_no_base(nullptr);
+    Span0 s0_with_base(nullptr, 4, base_buf);
+    CHECK_THROWS(sp_no_base = s0_no_base);     // nullptr assignment
+    CHECK_THROWS(sp_no_base = s0_with_base);   // nullptr assignment
+    CHECK_THROWS(sp_with_base = s0_no_base);   // nullptr assignment
+    CHECK_THROWS(sp_with_base = s0_with_base); // nullptr assignment
+#endif
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+TEST_CASE("Span") {
+    char real_buf[2 + 6 + 2] = {126, 127, 0, 1, 2, 3, 4, 5, 124, 125};
+    char *base_buf = real_buf + 2;
+    char *const my_null = nullptr;
+    typedef Span<char> SpanS;
+
+    // basic nullptr
+    CHECK_THROWS(SpanS(base_buf, 4, base_buf) = my_null);
+    CHECK_THROWS(SpanS(base_buf, 4, base_buf).assign(my_null));
+    // basic range checking
+    CHECK_NOTHROW(SpanS(base_buf, 4, base_buf));
+    CHECK_NOTHROW(SpanS(base_buf, 0, base_buf));
+    CHECK_NOTHROW(SpanS(base_buf, 0, base_buf) - 0);
+    CHECK_THROWS(SpanS(base_buf, 0, base_buf) + 1);
+    CHECK_THROWS(SpanS(base_buf, 0, base_buf) - 1);
+    CHECK_NOTHROW(SpanS(base_buf, 4, base_buf) + 4);
+    CHECK_THROWS(SpanS(base_buf, 4, base_buf) + 5);
+    CHECK_THROWS(SpanS(base_buf - 1, 4, base_buf));
+    CHECK_THROWS(SpanS(base_buf + 1, 0, base_buf));
+    // basic same base
+    CHECK_NOTHROW(SpanS(base_buf, 4, base_buf) = SpanS(base_buf + 1, 3, base_buf));
+    CHECK_NOTHROW(SpanS(base_buf, 4, base_buf) = SpanS(base_buf + 1, 1, base_buf));
+    CHECK_NOTHROW(SpanS(base_buf, 4, base_buf) = SpanS(base_buf + 1, 5, base_buf));
+    CHECK_THROWS(SpanS(base_buf, 4, base_buf) = SpanS(base_buf + 1, 3, base_buf + 1));
+
+    SpanS x1(base_buf, 0);
+    assert(x1 != nullptr);
+    assert(x1.raw_ptr() == base_buf);
+    assert(x1.raw_base() == base_buf);
+    assert(x1.raw_size_in_bytes() == 0u);
+    CHECK_THROWS(*x1);
+    CHECK_THROWS(x1[0]);
+
+    SpanS a2(base_buf, 4);
+    assert(a2 != nullptr);
+    assert(a2.raw_ptr() == base_buf);
+    assert(a2.raw_base() == base_buf);
+    assert(a2.raw_size_in_bytes() == 4u);
+    CHECK(*a2 == 0);
+    CHECK(a2[1] == 1);
+
+    SpanS base0(base_buf, 4, base_buf);
+    assert(base0.raw_ptr() == base_buf);
+    assert(base0.raw_base() == base_buf);
+    assert(base0.raw_size_in_bytes() == 4u);
+
+    SpanS base4(base_buf, 4);
+    assert(base4.raw_ptr() == base_buf);
+    assert(base4.raw_base() == base_buf);
+    assert(base4.raw_size_in_bytes() == 4u);
+
+    SpanS a1(base_buf, 4);
+    a1 = base_buf;
+    a1 = base0;
+    assert(a1 == base0);
+    assert(a1 != nullptr);
+    assert(a1.raw_ptr() == base0.raw_ptr());
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+    a1 = base4;
+    assert(a1 == base_buf);
+    assert(a1.raw_ptr() == base_buf);
+    assert(a1.raw_base() == base_buf);
+    assert(a1.raw_size_in_bytes() == 4u);
+
+    a1 = base_buf;
+    a1 = base_buf + 1;
+    CHECK(*a1++ == 1);
+    CHECK(*++a1 == 3);
+    CHECK(*a1 == 3);
+    a1 = base_buf + 4; // at the end of buffer
+    CHECK_THROWS(*a1);
+    CHECK_THROWS(a1 = base_buf + 5); // range error
+    assert(a1 == base_buf + 4);
+    CHECK(a1[-4] == 0);
+    CHECK_THROWS(a1[-5]); // range error
+    a1 = base_buf;
+    CHECK(*a1 == 0);
+
+    SpanS new_base4(base_buf + 2, 4);
+    CHECK_THROWS(a1 = new_base4); // not same base
+    CHECK_THROWS(a2 = new_base4); // not same base
+
+    SpanS ss_with_base(base_buf, 4, base_buf);
+    assert(ss_with_base.raw_base() == base_buf);
+    CHECK_THROWS(ss_with_base = my_null); // nullptr assignment
+#if XSPAN_CONFIG_ENABLE_SPAN_CONVERSION
+    {
+        typedef PtrOrSpanOrNull<char> Span0;
+        // v0 nullptr, b0 base, b1 base + 1
+        const Span0 v0_v0(nullptr);
+        const Span0 v0_b0(nullptr, 4, base_buf);
+        const Span0 v0_b1(nullptr, 3, base_buf + 1);
+        const Span0 b0_v0(base_buf);
+        const Span0 b0_b0(base_buf, 4, base_buf);
+        CHECK_THROWS(XSPAN_0_MAKE(char, base_buf, 3, base_buf + 1)); // b0_b1
+        const Span0 b1_v0(base_buf + 1);
+        const Span0 b1_b0(base_buf + 1, 4, base_buf);
+        const Span0 b1_b1(base_buf + 1, 3, base_buf + 1);
+        CHECK_THROWS(ss_with_base = v0_v0); // nullptr assignment
+        CHECK_THROWS(ss_with_base = v0_b0); // nullptr assignment
+        CHECK_THROWS(ss_with_base = v0_b1); // nullptr assignment
+        CHECK_NOTHROW(ss_with_base = b0_v0);
+        CHECK_NOTHROW(ss_with_base = b0_b0);
+        CHECK_NOTHROW(ss_with_base = b1_v0);
+        CHECK_NOTHROW(ss_with_base = b1_b0);
+        CHECK_THROWS(ss_with_base = b1_b1); // different base
+        CHECK_THROWS(XSPAN_S_MAKE(char, v0_v0));
+        CHECK_THROWS(XSPAN_S_MAKE(char, v0_b0));
+        CHECK_THROWS(XSPAN_S_MAKE(char, v0_b1));
+        CHECK_THROWS(XSPAN_S_MAKE(char, b0_v0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b0_b0));
+        CHECK_THROWS(XSPAN_S_MAKE(char, b1_v0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b1_b0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b1_b1));
+        //
+        CHECK((XSPAN_S_MAKE(char, b0_b0).raw_base() == base_buf));
+        CHECK((XSPAN_S_MAKE(char, b1_b0).raw_base() == base_buf));
+        CHECK((XSPAN_S_MAKE(char, b1_b1).raw_base() == base_buf + 1));
+    }
+    {
+        typedef PtrOrSpan<char> SpanP;
+        // v0 nullptr, b0 base, b1 base + 1
+        const SpanP b0_v0(base_buf);
+        const SpanP b0_b0(base_buf, 4, base_buf);
+        CHECK_THROWS(XSPAN_P_MAKE(char, base_buf, 3, base_buf + 1)); // b0_b1
+        const SpanP b1_v0(base_buf + 1);
+        const SpanP b1_b0(base_buf + 1, 4, base_buf);
+        const SpanP b1_b1(base_buf + 1, 3, base_buf + 1);
+        CHECK_NOTHROW(ss_with_base = b0_v0);
+        CHECK_NOTHROW(ss_with_base = b0_b0);
+        CHECK_NOTHROW(ss_with_base = b1_v0);
+        CHECK_NOTHROW(ss_with_base = b1_b0);
+        CHECK_THROWS(ss_with_base = b1_b1); // different base
+        CHECK_THROWS(XSPAN_S_MAKE(char, b0_v0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b0_b0));
+        CHECK_THROWS(XSPAN_S_MAKE(char, b1_v0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b1_b0));
+        CHECK_NOTHROW(XSPAN_S_MAKE(char, b1_b1));
+        //
+        CHECK((XSPAN_S_MAKE(char, b0_b0).raw_base() == base_buf));
+        CHECK((XSPAN_S_MAKE(char, b1_b0).raw_base() == base_buf));
+        CHECK((XSPAN_S_MAKE(char, b1_b1).raw_base() == base_buf + 1));
+    }
+#endif
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+TEST_CASE("Span void ptr") {
+    static char a[4] = {0, 1, 2, 3};
+    XSPAN_0(void) a0(a, 4);
+    XSPAN_P(void) ap(a, 4);
+    XSPAN_S(void) as(a, 4);
+    XSPAN_0(const void) c0(a, 4);
+    XSPAN_P(const void) cp(a, 4);
+    XSPAN_S(const void) cs(a, 4);
+    static const char b[4] = {0, 1, 2, 3};
+    XSPAN_0(const void) b0(b, 4);
+    XSPAN_P(const void) bp(b, 4);
+    XSPAN_S(const void) bs(b, 4);
+}
+
+TEST_CASE("Span deref/array/arrow") {
+    static char real_a[2 + 4 + 2] = {126, 127, 0, 1, 2, 3, 124, 125};
+    static char *a = real_a + 2;
+    XSPAN_0(char) a0(a, 4);
+    XSPAN_P(char) ap(a, 4);
+    XSPAN_S(char) as(a, 4);
+    CHECK_THROWS(a0[4]);
+    CHECK_THROWS(a0[-1]);
+    CHECK_THROWS(a0[-2]);
+    a0 += 2;
+    CHECK(*a0 == 2);
+    CHECK(a0[-1] == 1);
+    CHECK(a0[0] == 2);
+    CHECK(a0[1] == 3);
+    ap += 2;
+    CHECK(*ap == 2);
+    CHECK(ap[-1] == 1);
+    CHECK(ap[0] == 2);
+    CHECK(ap[1] == 3);
+    as += 2;
+    CHECK(*as == 2);
+    CHECK(as[-1] == 1);
+    CHECK(as[0] == 2);
+    CHECK(as[1] == 3);
+}
+
+TEST_CASE("Span subspan") {
+    static char buf[4] = {0, 1, 2, 3};
+    XSPAN_S(char) as(buf, 4);
+    CHECK(as.subspan(1, 1)[0] == 1);
+    CHECK((as + 1).subspan(1, 1)[0] == 2);
+    CHECK((as + 2).subspan(0, -2)[0] == 0);
+    CHECK_THROWS(as.subspan(1, 0)[0]);
+    CHECK_THROWS(as.subspan(1, 1)[-1]);
+}
+
+TEST_CASE("Span constness") {
+    static char buf[4] = {0, 1, 2, 3};
+
+    // NOLINTBEGIN(performance-unnecessary-copy-initialization)
+
+    XSPAN_0(char) b0(buf, 4);
+    XSPAN_P(char) bp(buf, 4);
+    XSPAN_S(char) bs(buf, 4);
+
+    XSPAN_0(char) s0(b0);
+    XSPAN_P(char) sp(bp);
+    XSPAN_S(char) ss(bs);
+
+    XSPAN_0(const char) b0c(buf, 4);
+    XSPAN_P(const char) bpc(buf, 4);
+    XSPAN_S(const char) bsc(buf, 4);
+
+    XSPAN_0(const char) s0c(b0c);
+    XSPAN_P(const char) spc(bpc);
+    XSPAN_S(const char) ssc(bsc);
+
+    XSPAN_0(const char) x0c(b0);
+    XSPAN_P(const char) xpc(bp);
+    XSPAN_S(const char) xsc(bs);
+
+    // NOLINTEND(performance-unnecessary-copy-initialization)
+
+    CHECK(ptr_diff_bytes(b0, buf) == 0);
+    CHECK(ptr_diff_bytes(bp, buf) == 0);
+    CHECK(ptr_diff_bytes(bs, buf) == 0);
+    CHECK(ptr_diff_bytes(s0, buf) == 0);
+    CHECK(ptr_diff_bytes(sp, buf) == 0);
+    CHECK(ptr_diff_bytes(bs, buf) == 0);
+    //
+    CHECK(ptr_diff_bytes(s0, bp) == 0);
+    CHECK(ptr_diff_bytes(s0, sp) == 0);
+    CHECK(ptr_diff_bytes(s0, ss) == 0);
+    //
+    CHECK(ptr_diff_bytes(s0c, b0c) == 0);
+    CHECK(ptr_diff_bytes(spc, bpc) == 0);
+    CHECK(ptr_diff_bytes(ssc, bsc) == 0);
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+#if !defined(DOCTEST_CONFIG_DISABLE)
+namespace {
+int my_memcmp_v1(XSPAN_P(const void) a, XSPAN_0(const void) b, size_t n) {
+    if (b == nullptr)
+        return -2;
+    XSPAN_0(const void) x(a);
+    return memcmp(x, b, n);
+}
+int my_memcmp_v2(XSPAN_P(const char) a, XSPAN_0(const char) b, size_t n) {
+    if (a == b)
+        return 0;
+    if (b == nullptr)
+        return -2;
+    a += 1;
+    b -= 1;
+    XSPAN_0(const char) x(a);
+    XSPAN_0(const char) y = b;
+    return memcmp(x, y, n);
+}
+} // namespace
+#endif
+
+TEST_CASE("PtrOrSpan") {
+    static const char buf[4] = {0, 1, 2, 3};
+    CHECK(my_memcmp_v1(buf, nullptr, 4) == -2);
+    CHECK(my_memcmp_v2(buf + 4, buf + 4, 999) == 0);
+    CHECK(my_memcmp_v2(buf, buf + 2, 3) == 0);
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+TEST_CASE("PtrOrSpan char") {
+    char real_buf[2 + 8 + 2] = {126, 127, 0, 1, 2, 3, 4, 5, 6, 7, 124, 125};
+    char *buf = real_buf + 2;
+    XSPAN_P(char) a(buf, XSpanSizeInBytes(8));
+    XSPAN_P(char) b = a.subspan(0, 7);
+    XSPAN_P(char) c = (b + 1).subspan(0, 6);
+    a += 1;
+    CHECK(*a == 1);
+    *a++ += 1;
+    *b++ = 1;
+    CHECK(a == buf + 2);
+    CHECK(b == buf + 1);
+    CHECK(c == buf + 1);
+    CHECK(*b == 2);
+    CHECK(*c == 2);
+    CHECK(a.raw_size_in_bytes() == 8u);
+    CHECK(b.raw_size_in_bytes() == 7u);
+    CHECK(c.raw_size_in_bytes() == 6u);
+    CHECK(a.raw_base() == buf);
+    CHECK(b.raw_base() == buf);
+    CHECK(c.raw_base() == buf + 1);
+#ifdef UPX_VERSION_HEX
+    CHECK(get_le32(a) != 0);
+#endif
+    ++c;
+    c++;
+#ifdef UPX_VERSION_HEX
+    CHECK(get_le32(c) != 0);
+#endif
+    ++c;
+#ifdef UPX_VERSION_HEX
+    CHECK_THROWS(get_le32(c));
+#endif
+    ++b;
+    b++;
+    b += 4;
+    CHECK(b.raw_ptr() == buf + 7);
+    CHECK_THROWS(*b);
+    CHECK(a.raw_size_in_bytes() == 8u);
+    a = b;
+    CHECK(a.raw_size_in_bytes() == 8u);
+    CHECK(a.raw_ptr() == buf + 7);
+    a++;
+    CHECK_THROWS(*a);
+    CHECK_THROWS(raw_bytes(a, 1));
+    a = b;
+    CHECK_THROWS(a = c);
+    *a = 0;
+    a = buf;
+#ifdef UPX_VERSION_HEX
+    CHECK(upx_safe_strlen(a) == 7u);
+#endif
+}
+
+TEST_CASE("PtrOrSpan int") {
+    int buf[8] = {0, 11, 22, 33, 44, 55, 66, 77};
+    XSPAN_P(const int) a(buf, XSpanCount(8));
+    CHECK(a.raw_size_in_bytes() == 8 * sizeof(int));
+    XSPAN_P(const int) b = a.subspan(0, 7);
+    CHECK(b.raw_size_in_bytes() == 7 * sizeof(int));
+    XSPAN_P(const int) c = (b + 1).subspan(0, 6);
+    CHECK(c.raw_size_in_bytes() == 6 * sizeof(int));
+    a += 1;
+    CHECK(a == buf + 1);
+    CHECK(*a == 11);
+    CHECK(*a++ == 11);
+    CHECK(a == buf + 2);
+    CHECK(*a == 22);
+    CHECK(*++a == 33);
+    CHECK(a == buf + 3);
+    CHECK(*a == 33);
+    CHECK(*--a == 22);
+    CHECK(a == buf + 2);
+    CHECK(*a == 22);
+    CHECK(*a-- == 22);
+    CHECK(a == buf + 1);
+    CHECK(*a == 11);
+    CHECK(*b == 0);
+    CHECK(*c == 11);
+    a -= 1;
+    a += 7;
+#ifdef UPX_VERSION_HEX
+    CHECK(get_le32(a) == ne32_to_le32(77));
+#endif
+    a++;
+#ifdef UPX_VERSION_HEX
+    CHECK_THROWS(get_le32(a));
+#endif
+    CHECK_THROWS(raw_bytes(a, 1));
+    CHECK_THROWS(a++);
+    CHECK_THROWS(++a);
+    CHECK_THROWS(a += 1);
+    CHECK(a == buf + 8);
+    a = buf;
+    CHECK_THROWS(a--);
+    CHECK_THROWS(--a);
+    CHECK_THROWS(a -= 1);
+    CHECK_THROWS(a += 9);
+    CHECK(a == buf);
+    a += 8;
+    CHECK(a == buf + 8);
+}
+
+/*************************************************************************
+// codegen
+**************************************************************************/
+
+namespace {
+template <class T>
+__acc_static_noinline int foo(T p) {
+    unsigned r = 0;
+    r += *p++;
+    r += *++p;
+    p += 3;
+    r += *p;
+    r += *--p;
+    r += *p--;
+    r += *p;
+    return r;
+}
+
+template <class T>
+XSPAN_0(T)
+make_span_0(T *ptr, size_t count) {
+    return PtrOrSpanOrNull<T>(ptr, count);
+}
+template <class T>
+XSPAN_P(T)
+make_span_p(T *ptr, size_t count) {
+    return PtrOrSpan<T>(ptr, count);
+}
+template <class T>
+XSPAN_S(T)
+make_span_s(T *ptr, size_t count) {
+    return Span<T>(ptr, count);
+}
+} // namespace
+
+TEST_CASE("Span codegen") {
+    upx_uint8_t buf[8] = {0, 1, 2, 3, 4, 5, 6, 7};
+    CHECK(foo(buf) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(make_span_0(buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(make_span_p(buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(make_span_s(buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(XSPAN_0_MAKE(upx_uint8_t, buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(XSPAN_P_MAKE(upx_uint8_t, buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+    CHECK(foo(XSPAN_S_MAKE(upx_uint8_t, buf, 8)) == 0 + 2 + 5 + 4 + 4 + 3);
+}
+
+#endif // WITH_XSPAN >= 2
+
+/* vim:set ts=4 sw=4 et: */

src/compress.cpp

@@ -1,270 +0,0 @@
-/* compress.cpp -- interface to the compression library
-
-   This file is part of the UPX executable compressor.
-
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
-   All Rights Reserved.
-
-   UPX and the UCL library are free software; you can redistribute them
-   and/or modify them under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
-
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.
-   If not, write to the Free Software Foundation, Inc.,
-   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-
-   Markus F.X.J. Oberhumer                   Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
- */
-
-
-#include "conf.h"
-
-#if defined(WITH_UCL) && !defined(WITH_NRV)
-#  define nrv2b_99_compress_internal    ucl_nrv2b_99_compress
-#  define nrv2d_99_compress_internal    ucl_nrv2d_99_compress
-#  if 0 && defined(__i386__)
-#    include <ucl/ucl_asm.h>
-#    define nrv2b_decompress_safe_8     ucl_nrv2b_decompress_asm_safe_8
-#    define nrv2b_decompress_safe_le16  ucl_nrv2b_decompress_asm_safe_le16
-#    define nrv2b_decompress_safe_le32  ucl_nrv2b_decompress_asm_safe_le32
-#    define nrv2d_decompress_safe_8     ucl_nrv2d_decompress_asm_safe_8
-#    define nrv2d_decompress_safe_le16  ucl_nrv2d_decompress_asm_safe_le16
-#    define nrv2d_decompress_safe_le32  ucl_nrv2d_decompress_asm_safe_le32
-#  else
-#    define nrv2b_decompress_safe_8     ucl_nrv2b_decompress_safe_8
-#    define nrv2b_decompress_safe_le16  ucl_nrv2b_decompress_safe_le16
-#    define nrv2b_decompress_safe_le32  ucl_nrv2b_decompress_safe_le32
-#    define nrv2d_decompress_safe_8     ucl_nrv2d_decompress_safe_8
-#    define nrv2d_decompress_safe_le16  ucl_nrv2d_decompress_safe_le16
-#    define nrv2d_decompress_safe_le32  ucl_nrv2d_decompress_safe_le32
-#  endif
-#endif
-
-#if defined(WITH_NRV)
-#  include <nrv/nrv2b.h>
-#  include <nrv/nrv2d.h>
-#  if !defined(NRV_VERSION) || (NRV_VERSION < 0x007300L)
-#    error
-#  endif
-#  if 1 && defined(__i386__)
-#    define nrv2b_decompress_safe_8     nrv2b_decompress_asm_safe_8
-#    define nrv2b_decompress_safe_le16  nrv2b_decompress_asm_safe_le16
-#    define nrv2d_decompress_safe_8     nrv2d_decompress_asm_safe_8
-#    define nrv2d_decompress_safe_le16  nrv2d_decompress_asm_safe_le16
-#    if (NRV_VERSION < 0x008000L)
-#    define nrv2b_decompress_safe_le32  nrv2b_decompress_asm_safe
-#    define nrv2d_decompress_safe_le32  nrv2d_decompress_asm_safe
-#    else
-#    define nrv2b_decompress_safe_le32  nrv2b_decompress_asm_safe_le32
-#    define nrv2d_decompress_safe_le32  nrv2d_decompress_asm_safe_le32
-#    endif
-#  endif
-   NRV_EXTERN_CDECL(int) nrv2b_99_compress_internal(...);
-   NRV_EXTERN_CDECL(int) nrv2d_99_compress_internal(...);
-   NRV_EXTERN_CDECL(int) nrv2b_decompress_safe_8(...);
-   NRV_EXTERN_CDECL(int) nrv2b_decompress_safe_le16(...);
-   NRV_EXTERN_CDECL(int) nrv2b_decompress_safe_le32(...);
-   NRV_EXTERN_CDECL(int) nrv2d_decompress_safe_8(...);
-   NRV_EXTERN_CDECL(int) nrv2d_decompress_safe_le16(...);
-   NRV_EXTERN_CDECL(int) nrv2d_decompress_safe_le32(...);
-#endif
-
-#if 0 && defined(WITH_ZLIB) && defined(M_ZLIB)
-#  include <zlib.h>
-#endif
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-int upx_compress           ( const upx_byte *src, upx_uint  src_len,
-                                   upx_byte *dst, upx_uint *dst_len,
-                                   upx_progress_callback_t *cb,
-                                   int method, int level,
-                             const struct upx_compress_config_t *conf_parm,
-                                   upx_uintp result)
-{
-    struct upx_compress_config_t conf;
-    upx_uint result_buffer[16];
-    int r = UPX_E_ERROR;
-
-    assert(level > 0);
-    memset(&conf, 0xff, sizeof(conf));
-    if (conf_parm)
-        conf = *conf_parm;     // struct copy
-    if (!result)
-        result = result_buffer;
-
-    // assume no info available - fill in worst case results
-    //result[0] = 1;            // min_offset_found - NOT USED
-    result[1] = src_len - 1;    // max_offset_found
-    //result[2] = 2;            // min_match_found - NOT USED
-    result[3] = src_len - 1;    // max_match_found
-    //result[4] = 1;            // min_run_found - NOT USED
-    result[5] = src_len;        // max_run_found
-    result[6] = 1;              // first_offset_found
-    //result[7] = 999999;       // same_match_offsets_found - NOT USED
-
-#if 0 && defined(WITH_ZLIB) && defined(M_ZLIB)
-    if (method == M_ZLIB)
-    {
-        uLong destLen = src_len + src_len / 8 + 256;
-        r = compress2(dst, &destLen, src, src_len, UPX_MIN(level, 9));
-        *dst_len = destLen;
-        if (r == Z_MEM_ERROR)
-            return UPX_E_OUT_OF_MEMORY;
-        if (r != Z_OK)
-            return UPX_E_ERROR;
-        return UPX_E_OK;
-    }
-#endif
-
-    // prepare bit-buffer settings
-    conf.bb_endian = 0;
-    conf.bb_size = 0;
-    if (method == M_NRV2B_LE32 || method == M_NRV2D_LE32)
-        conf.bb_size = 32;
-    else if (method == M_NRV2B_8 || method == M_NRV2D_8)
-        conf.bb_size = 8;
-    else if (method == M_NRV2B_LE16 || method == M_NRV2D_LE16)
-        conf.bb_size = 16;
-    else
-        throwInternalError("unknown compression method");
-
-#if 1 && defined(WITH_NRV)
-    if (level == 1 && conf.bb_size == 32 &&
-        conf.max_offset == UPX_UINT_MAX && conf.max_match == UPX_UINT_MAX)
-    {
-        if (method == M_NRV2B_LE32)
-        {
-            upx_byte wrkmem[NRV2B_1_16_MEM_COMPRESS];
-#if defined(__UPX_CHECKER)
-            memset(wrkmem,0,NRV2B_1_16_MEM_COMPRESS);
-#endif
-            r = nrv2b_1_16_compress(src, src_len, dst, dst_len, wrkmem);
-        }
-        else if (method == M_NRV2D_LE32)
-        {
-            upx_byte wrkmem[NRV2D_1_16_MEM_COMPRESS];
-#if defined(__UPX_CHECKER)
-            memset(wrkmem,0,NRV2D_1_16_MEM_COMPRESS);
-#endif
-            r = nrv2d_1_16_compress(src, src_len, dst, dst_len, wrkmem);
-        }
-        else
-            throwInternalError("unknown compression method");
-        return r;
-    }
-#endif
-
-    // optimize compression parms
-    if (level <= 3 && conf.max_offset == UPX_UINT_MAX)
-        conf.max_offset = 8*1024-1;
-    else if (level == 4 && conf.max_offset == UPX_UINT_MAX)
-        conf.max_offset = 32*1024-1;
-#if defined(WITH_NRV)
-    else if (level <= 7 && conf.max_offset == UPX_UINT_MAX)
-        conf.max_offset = 1024*1024-1;
-    else if (level <= 8 && conf.max_offset == UPX_UINT_MAX)
-        conf.max_offset = 2048*1024-1;
-    else if (level <= 10 && conf.max_offset == UPX_UINT_MAX)
-        conf.max_offset = 4096*1024-1;
-#endif
-
-    if M_IS_NRV2B(method)
-        r = nrv2b_99_compress_internal(src, src_len, dst, dst_len,
-                                       cb, level, &conf, result);
-    else if M_IS_NRV2D(method)
-        r = nrv2d_99_compress_internal(src, src_len, dst, dst_len,
-                                       cb, level, &conf, result);
-    else
-        throwInternalError("unknown compression method");
-
-    return r;
-}
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-int upx_decompress         ( const upx_byte *src, upx_uint  src_len,
-                                   upx_byte *dst, upx_uint *dst_len,
-                                   int method )
-{
-    int r = UPX_E_ERROR;
-
-#if 0 && defined(WITH_ZLIB) && defined(M_ZLIB)
-    if (method == M_ZLIB)
-    {
-        uLong destLen = *dst_len;
-        r = uncompress(dst, &destLen, src, src_len);
-        *dst_len = destLen;
-        if (r == Z_MEM_ERROR)
-            return UPX_E_OUT_OF_MEMORY;
-        if (r != Z_OK)
-            return UPX_E_ERROR;
-        return UPX_E_OK;
-    }
-#endif
-
-    if (method == M_NRV2B_LE32)
-        r = nrv2b_decompress_safe_le32(src,src_len,dst,dst_len,NULL);
-    else if (method == M_NRV2B_8)
-        r = nrv2b_decompress_safe_8(src,src_len,dst,dst_len,NULL);
-    else if (method == M_NRV2B_LE16)
-        r = nrv2b_decompress_safe_le16(src,src_len,dst,dst_len,NULL);
-    else if (method == M_NRV2D_LE32)
-        r = nrv2d_decompress_safe_le32(src,src_len,dst,dst_len,NULL);
-    else if (method == M_NRV2D_8)
-        r = nrv2d_decompress_safe_8(src,src_len,dst,dst_len,NULL);
-    else if (method == M_NRV2D_LE16)
-        r = nrv2d_decompress_safe_le16(src,src_len,dst,dst_len,NULL);
-    else
-        throwInternalError("unknown decompression method");
-    return r;
-}
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-int upx_test_overlap       ( const upx_byte *buf, upx_uint src_off,
-                                   upx_uint  src_len, upx_uint *dst_len,
-                                   int method )
-{
-    int r = UPX_E_ERROR;
-
-    if (method == M_NRV2B_LE32)
-        r = ucl_nrv2b_test_overlap_le32(buf,src_off,src_len,dst_len,NULL);
-    else if (method == M_NRV2B_8)
-        r = ucl_nrv2b_test_overlap_8(buf,src_off,src_len,dst_len,NULL);
-    else if (method == M_NRV2B_LE16)
-        r = ucl_nrv2b_test_overlap_le16(buf,src_off,src_len,dst_len,NULL);
-    else if (method == M_NRV2D_LE32)
-        r = ucl_nrv2d_test_overlap_le32(buf,src_off,src_len,dst_len,NULL);
-    else if (method == M_NRV2D_8)
-        r = ucl_nrv2d_test_overlap_8(buf,src_off,src_len,dst_len,NULL);
-    else if (method == M_NRV2D_LE16)
-        r = ucl_nrv2d_test_overlap_le16(buf,src_off,src_len,dst_len,NULL);
-    else
-        throwInternalError("unknown decompression method");
-    return r;
-}
-
-
-/*
-vi:ts=4:et:nowrap
-*/
-

src/compress/compress.cpp

@@ -0,0 +1,208 @@
+/* compress.cpp --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+#include "compress.h"
+#include "../util/membuffer.h"
+
+/*************************************************************************
+//
+**************************************************************************/
+
+unsigned upx_adler32(const void *buf, unsigned len, unsigned adler) {
+    if (len == 0)
+        return adler;
+    assert(buf != nullptr);
+#if 1
+    return upx_ucl_adler32(buf, len, adler);
+#else
+    return upx_zlib_adler32(buf, len, adler);
+#endif
+}
+
+#if 0 // UNUSED
+unsigned upx_crc32(const void *buf, unsigned len, unsigned crc)
+{
+    if (len == 0)
+        return crc;
+    assert(buf != nullptr);
+#if 1
+    return upx_ucl_crc32(buf, len, crc);
+#else
+    return upx_zlib_crc32(buf, len, crc);
+#endif
+}
+#endif // UNUSED
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_compress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                 upx_callback_p cb, int method, int level, const upx_compress_config_t *cconf,
+                 upx_compress_result_t *cresult) {
+    int r = UPX_E_ERROR;
+    upx_compress_result_t cresult_buffer;
+
+    assert(method > 0);
+    assert(level > 0);
+
+#if 1
+    // set available bytes in dst
+    if (*dst_len == 0)
+        *dst_len = MemBuffer::getSizeForCompression(src_len);
+#else
+    // force users to provide *dst_len
+    assert(*dst_len != 0);
+#endif
+    // for UPX, we always require a reasonably sized output buffer
+    assert(*dst_len >= MemBuffer::getSizeForCompression(src_len));
+
+    if (!cresult)
+        cresult = &cresult_buffer;
+    cresult->reset();
+#if 1
+    // debugging aid
+    cresult->debug.method = method;
+    cresult->debug.level = level;
+    cresult->debug.u_len = src_len;
+    cresult->debug.c_len = 0;
+#endif
+
+    if (__acc_cte(false)) {
+    }
+#if (WITH_LZMA)
+    else if (M_IS_LZMA(method))
+        r = upx_lzma_compress(src, src_len, dst, dst_len, cb, method, level, cconf, cresult);
+#endif
+#if (WITH_NRV)
+    else if ((M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method)) && !opt->prefer_ucl)
+        r = upx_nrv_compress(src, src_len, dst, dst_len, cb, method, level, cconf, cresult);
+#endif
+#if (WITH_UCL)
+    else if (M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method))
+        r = upx_ucl_compress(src, src_len, dst, dst_len, cb, method, level, cconf, cresult);
+#endif
+#if (WITH_ZSTD)
+    else if (M_IS_ZSTD(method))
+        r = upx_zstd_compress(src, src_len, dst, dst_len, cb, method, level, cconf, cresult);
+#endif
+    else {
+        throwInternalError("unknown compression method");
+    }
+
+#if 1
+    // debugging aid
+    cresult->debug.c_len = *dst_len;
+#endif
+    return r;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_decompress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                   int method, const upx_compress_result_t *cresult) {
+    int r = UPX_E_ERROR;
+
+    assert(*dst_len > 0);
+    assert(src_len < *dst_len); // must be compressed
+
+    if (cresult && cresult->debug.method == 0)
+        cresult = nullptr;
+
+    if (__acc_cte(false)) {
+    }
+#if (WITH_LZMA)
+    else if (M_IS_LZMA(method))
+        r = upx_lzma_decompress(src, src_len, dst, dst_len, method, cresult);
+#endif
+#if (WITH_NRV)
+    else if ((M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method)) && !opt->prefer_ucl)
+        r = upx_nrv_decompress(src, src_len, dst, dst_len, method, cresult);
+#endif
+#if (WITH_UCL)
+    else if (M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method))
+        r = upx_ucl_decompress(src, src_len, dst, dst_len, method, cresult);
+#endif
+#if (WITH_ZLIB)
+    else if (M_IS_DEFLATE(method))
+        r = upx_zlib_decompress(src, src_len, dst, dst_len, method, cresult);
+#endif
+#if (WITH_ZSTD)
+    else if (M_IS_ZSTD(method))
+        r = upx_zstd_decompress(src, src_len, dst, dst_len, method, cresult);
+#endif
+    else {
+        throwInternalError("unknown decompression method");
+    }
+
+    return r;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_test_overlap(const upx_bytep buf, const upx_bytep tbuf, unsigned src_off, unsigned src_len,
+                     unsigned *dst_len, int method, const upx_compress_result_t *cresult) {
+    int r = UPX_E_ERROR;
+
+    if (cresult && cresult->debug.method == 0)
+        cresult = nullptr;
+
+    assert(*dst_len > 0);
+    assert(src_len < *dst_len); // must be compressed
+    unsigned overlap_overhead = src_off + src_len - *dst_len;
+    assert((int) overlap_overhead > 0);
+
+    if (__acc_cte(false)) {
+    }
+#if (WITH_LZMA)
+    else if (M_IS_LZMA(method))
+        r = upx_lzma_test_overlap(buf, tbuf, src_off, src_len, dst_len, method, cresult);
+#endif
+#if (WITH_NRV)
+    else if ((M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method)) && !opt->prefer_ucl)
+        r = upx_nrv_test_overlap(buf, tbuf, src_off, src_len, dst_len, method, cresult);
+#endif
+#if (WITH_UCL)
+    else if (M_IS_NRV2B(method) || M_IS_NRV2D(method) || M_IS_NRV2E(method))
+        r = upx_ucl_test_overlap(buf, tbuf, src_off, src_len, dst_len, method, cresult);
+#endif
+#if (WITH_ZSTD)
+    else if (M_IS_ZSTD(method))
+        r = upx_zstd_test_overlap(buf, tbuf, src_off, src_len, dst_len, method, cresult);
+#endif
+    else {
+        throwInternalError("unknown decompression method");
+    }
+
+    return r;
+}
+
+/* vim:set ts=4 sw=4 et: */

src/compress/compress.h

@@ -0,0 +1,173 @@
+/* compress.h --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#pragma once
+#ifndef UPX_COMPRESS_H__
+#define UPX_COMPRESS_H__ 1
+
+/*************************************************************************
+//
+**************************************************************************/
+
+#if (WITH_BZIP2)
+int upx_bzip2_init(void);
+const char *upx_bzip2_version_string(void);
+int upx_bzip2_compress     ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_bzip2_decompress   ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_bzip2_test_overlap ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+#endif
+
+
+#if (WITH_LZMA)
+int upx_lzma_init(void);
+const char *upx_lzma_version_string(void);
+int upx_lzma_compress      ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_lzma_decompress    ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_lzma_test_overlap  ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+#endif
+
+
+#if (WITH_NRV)
+int upx_nrv_init(void);
+const char *upx_nrv_version_string(void);
+int upx_nrv_compress       ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_nrv_decompress     ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_nrv_test_overlap   ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+#endif
+
+
+#if (WITH_UCL)
+int upx_ucl_init(void);
+const char *upx_ucl_version_string(void);
+int upx_ucl_compress       ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_ucl_decompress     ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_ucl_test_overlap   ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+unsigned upx_ucl_adler32(const void *buf, unsigned len, unsigned adler);
+unsigned upx_ucl_crc32  (const void *buf, unsigned len, unsigned crc);
+#endif
+
+
+#if (WITH_ZLIB)
+int upx_zlib_init(void);
+const char *upx_zlib_version_string(void);
+int upx_zlib_compress      ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_zlib_decompress    ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_zlib_test_overlap  ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+unsigned upx_zlib_adler32(const void *buf, unsigned len, unsigned adler);
+unsigned upx_zlib_crc32  (const void *buf, unsigned len, unsigned crc);
+#endif
+
+
+#if (WITH_ZSTD)
+int upx_zstd_init(void);
+const char *upx_zstd_version_string(void);
+int upx_zstd_compress      ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   upx_callback_p cb,
+                                   int method, int level,
+                             const upx_compress_config_t *cconf,
+                                   upx_compress_result_t *cresult );
+int upx_zstd_decompress    ( const upx_bytep src, unsigned  src_len,
+                                   upx_bytep dst, unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+int upx_zstd_test_overlap  ( const upx_bytep buf,
+                             const upx_bytep tbuf,
+                                   unsigned  src_off, unsigned src_len,
+                                   unsigned* dst_len,
+                                   int method,
+                             const upx_compress_result_t *cresult );
+#endif
+
+
+#endif /* already included */
+
+/* vim:set ts=4 sw=4 et: */

src/compress/compress_lzma.cpp

@@ -0,0 +1,552 @@
+/* compress_lzma.cpp --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+#include "compress.h"
+#include "../util/membuffer.h"
+
+#if (ACC_CC_CLANG)
+#pragma clang diagnostic ignored "-Wshadow"
+#endif
+#if (ACC_CC_GNUC >= 0x040200)
+#pragma GCC diagnostic ignored "-Wshadow"
+#endif
+#if (ACC_CC_MSC)
+#pragma warning(disable : 4456) // -Wno-shadow
+#endif
+#if (ACC_CC_MSC && (_MSC_VER < 1900))
+#pragma warning(disable : 4127) // warning C4127: conditional expression is constant
+#endif
+
+void lzma_compress_config_t::reset() noexcept {
+    pos_bits.reset();
+    lit_pos_bits.reset();
+    lit_context_bits.reset();
+    dict_size.reset();
+    fast_mode = 2;
+    num_fast_bytes.reset();
+    match_finder_cycles = 0;
+
+    max_num_probs = 0;
+}
+
+// INFO: the LZMA SDK is covered by a permissive license which allows
+//   using unmodified LZMA source code in UPX and the UPX stubs.
+//   See SPECIAL EXCEPTION below.
+//
+// Quoting from lzma-4.43/lzma.txt:
+//
+//   LICENSE
+//   -------
+//
+//   LZMA SDK is available under any of the following licenses:
+//
+//   1) GNU Lesser General Public License (GNU LGPL)
+//   2) Common Public License (CPL)
+//   3) Simplified license for unmodified code (read SPECIAL EXCEPTION)
+//   4) Proprietary license
+//
+//   It means that you can select one of these four options and follow rules
+//   of that license.
+//
+//   1,2) GNU LGPL and CPL licenses are pretty similar and both these
+//   licenses are classified as
+//    - "Free software licenses" at http://www.gnu.org/
+//    - "OSI-approved" at http://www.opensource.org/
+//
+//   3) SPECIAL EXCEPTION
+//
+//   Igor Pavlov, as the author of this code, expressly permits you
+//   to statically or dynamically link your code (or bind by name)
+//   to the files from LZMA SDK without subjecting your linked
+//   code to the terms of the CPL or GNU LGPL.
+//   Any modifications or additions to files from LZMA SDK, however,
+//   are subject to the GNU LGPL or CPL terms.
+//
+//   SPECIAL EXCEPTION allows you to use LZMA SDK in applications with closed code,
+//   while you keep LZMA SDK code unmodified.
+
+/*************************************************************************
+// compress defaults
+**************************************************************************/
+
+static bool prepare_result(lzma_compress_result_t *res, unsigned src_len, int method, int level,
+                           const lzma_compress_config_t *lcconf) {
+    // setup defaults
+    res->pos_bits = 2;                // 0 .. 4
+    res->lit_pos_bits = 0;            // 0 .. 4
+    res->lit_context_bits = 3;        // 0 .. 8
+    res->dict_size = 4 * 1024 * 1024; // 1 .. 2**30
+    res->fast_mode = 2;               // 0 .. 2
+    res->num_fast_bytes = 64;         // 5 .. 273
+    res->match_finder_cycles = 0;
+    // UPX overrides
+    res->pos_bits = lzma_compress_config_t::pos_bits_t::default_value;
+    res->lit_pos_bits = lzma_compress_config_t::lit_pos_bits_t::default_value;
+    res->lit_context_bits = lzma_compress_config_t::lit_context_bits_t::default_value;
+    res->dict_size = lzma_compress_config_t::dict_size_t::default_value;
+    res->num_fast_bytes = lzma_compress_config_t::num_fast_bytes_t::default_value;
+    // method overrides
+    if (method >= 0x100) {
+        res->pos_bits = (method >> 16) & 15;
+        res->lit_pos_bits = (method >> 12) & 15;
+        res->lit_context_bits = (method >> 8) & 15;
+    }
+#if 0
+    // DEBUG - set sizes so that we use a maximum amount of stack.
+    //  These settings cause res->num_probs == 3147574, i.e. we will
+    //  need about 6 MiB of stack during runtime decompression.
+    res->lit_pos_bits     = 4;
+    res->lit_context_bits = 8;
+#endif
+
+    // TODO: tune these settings according to level
+    switch (level) {
+    case 1:
+        res->dict_size = 256 * 1024;
+        res->fast_mode = 0;
+        res->num_fast_bytes = 8;
+        break;
+    case 2:
+        res->dict_size = 256 * 1024;
+        res->fast_mode = 0;
+        break;
+    case 3:
+        break;
+    case 4:
+        break;
+    case 5:
+        break;
+    case 6:
+        break;
+    case 7:
+        break;
+    case 8:
+        break;
+    case 9:
+        res->dict_size = 8 * 1024 * 1024;
+        break;
+    case 10:
+        res->dict_size = src_len;
+        break;
+    default:
+        goto error;
+    }
+
+    // cconf overrides
+    if (lcconf) {
+        oassign(res->pos_bits, lcconf->pos_bits);
+        oassign(res->lit_pos_bits, lcconf->lit_pos_bits);
+        oassign(res->lit_context_bits, lcconf->lit_context_bits);
+        oassign(res->dict_size, lcconf->dict_size);
+        oassign(res->num_fast_bytes, lcconf->num_fast_bytes);
+    }
+
+    // limit dictionary size
+    if (res->dict_size > src_len)
+        res->dict_size = src_len;
+
+    // limit num_probs
+    if (lcconf && lcconf->max_num_probs) {
+        for (;;) {
+            unsigned n = 1846 + (768u << (res->lit_context_bits + res->lit_pos_bits));
+            if (n <= lcconf->max_num_probs)
+                break;
+            if (res->lit_pos_bits > res->lit_context_bits) {
+                if (res->lit_pos_bits == 0)
+                    goto error;
+                res->lit_pos_bits -= 1;
+            } else {
+                if (res->lit_context_bits == 0)
+                    goto error;
+                res->lit_context_bits -= 1;
+            }
+        }
+    }
+
+    lzma_compress_config_t::pos_bits_t::assertValue(res->pos_bits);
+    lzma_compress_config_t::lit_pos_bits_t::assertValue(res->lit_pos_bits);
+    lzma_compress_config_t::lit_context_bits_t::assertValue(res->lit_context_bits);
+    lzma_compress_config_t::dict_size_t::assertValue(res->dict_size);
+    lzma_compress_config_t::num_fast_bytes_t::assertValue(res->num_fast_bytes);
+
+    res->num_probs = 1846 + (768u << (res->lit_context_bits + res->lit_pos_bits));
+    NO_printf("\nlzma_compress config: %u %u %u %u %u\n", res->pos_bits, res->lit_pos_bits,
+              res->lit_context_bits, res->dict_size, res->num_probs);
+    return true;
+
+error:
+    return false;
+}
+
+/*************************************************************************
+// compress - cruft because of pseudo-COM layer
+**************************************************************************/
+
+// ensure proper nullptr usage
+// TODO later: examine why we need this in the first place
+#undef NULL
+// NOLINTBEGIN(clang-analyzer-optin.cplusplus.*)
+#define NULL nullptr
+// NOLINTEND(clang-analyzer-optin.cplusplus.*)
+#if defined(__GNUC__)
+#undef __null
+#define __null nullptr
+#endif
+
+#undef MSDOS
+#undef OS2
+#undef _WIN32
+#undef _WIN32_WCE
+#undef COMPRESS_MF_MT
+#undef _NO_EXCEPTIONS
+#include <lzma-sdk/C/Common/MyInitGuid.h>
+// #include <lzma-sdk/C/7zip/Compress/LZMA/LZMADecoder.h>
+#include <lzma-sdk/C/7zip/Compress/LZMA/LZMAEncoder.h>
+
+namespace MyLzma {
+
+struct InStream final : public ISequentialInStream, public CMyUnknownImp {
+    virtual ~InStream() {}
+    MY_UNKNOWN_IMP
+    const Byte *b_buf = nullptr;
+    size_t b_size;
+    size_t b_pos;
+    void Init(const Byte *data, size_t size) {
+        b_buf = data;
+        b_size = size;
+        b_pos = 0;
+    }
+    STDMETHOD(Read)(void *data, UInt32 size, UInt32 *processedSize) override;
+};
+
+STDMETHODIMP InStream::Read(void *data, UInt32 size, UInt32 *processedSize) {
+    size_t remain = b_size - b_pos;
+    if (size > remain)
+        size = (UInt32) remain;
+    memmove(data, b_buf + b_pos, size);
+    b_pos += size;
+    if (processedSize != nullptr)
+        *processedSize = size;
+    return S_OK;
+}
+
+struct OutStream final : public ISequentialOutStream, public CMyUnknownImp {
+    virtual ~OutStream() {}
+    MY_UNKNOWN_IMP
+    Byte *b_buf = nullptr;
+    size_t b_size;
+    size_t b_pos;
+    bool overflow;
+    void Init(Byte *data, size_t size) {
+        b_buf = data;
+        b_size = size;
+        b_pos = 0;
+        overflow = false;
+    }
+    HRESULT WriteByte(Byte c) {
+        if (b_pos >= b_size) {
+            overflow = true;
+            return E_FAIL;
+        }
+        b_buf[b_pos++] = c;
+        return S_OK;
+    }
+    STDMETHOD(Write)(const void *data, UInt32 size, UInt32 *processedSize) override;
+};
+
+STDMETHODIMP OutStream::Write(const void *data, UInt32 size, UInt32 *processedSize) {
+    size_t remain = b_size - b_pos;
+    if (size > remain)
+        size = (UInt32) remain, overflow = true;
+    memmove(b_buf + b_pos, data, size);
+    b_pos += size;
+    if (processedSize != nullptr)
+        *processedSize = size;
+    return overflow ? E_FAIL : S_OK;
+}
+
+struct ProgressInfo final : public ICompressProgressInfo, public CMyUnknownImp {
+    virtual ~ProgressInfo() {}
+    MY_UNKNOWN_IMP
+    STDMETHOD(SetRatioInfo)(const UInt64 *inSize, const UInt64 *outSize) override;
+    upx_callback_p cb = nullptr;
+};
+
+STDMETHODIMP ProgressInfo::SetRatioInfo(const UInt64 *inSize, const UInt64 *outSize) {
+    if (cb && cb->nprogress)
+        cb->nprogress(cb, (unsigned) *inSize, (unsigned) *outSize);
+    return S_OK;
+}
+
+} // namespace MyLzma
+
+#include <lzma-sdk/C/Common/Alloc.cpp>
+#include <lzma-sdk/C/Common/CRC.cpp>
+// #include <lzma-sdk/C/7zip/Common/InBuffer.cpp>
+#include <lzma-sdk/C/7zip/Common/OutBuffer.cpp>
+#include <lzma-sdk/C/7zip/Common/StreamUtils.cpp>
+#include <lzma-sdk/C/7zip/Compress/LZ/LZInWindow.cpp>
+// #include <lzma-sdk/C/7zip/Compress/LZ/LZOutWindow.cpp>
+// #include <lzma-sdk/C/7zip/Compress/LZMA/LZMADecoder.cpp>
+#include <lzma-sdk/C/7zip/Compress/LZMA/LZMAEncoder.cpp>
+#include <lzma-sdk/C/7zip/Compress/RangeCoder/RangeCoderBit.cpp>
+#undef RC_NORMALIZE
+
+int upx_lzma_compress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                      upx_callback_p cb, int method, int level,
+                      const upx_compress_config_t *cconf_parm, upx_compress_result_t *cresult) {
+    assert(M_IS_LZMA(method));
+    assert(level > 0);
+    assert(cresult != nullptr);
+
+    int r = UPX_E_ERROR;
+    HRESULT rh;
+    const lzma_compress_config_t *const lcconf = cconf_parm ? &cconf_parm->conf_lzma : nullptr;
+    lzma_compress_result_t *const res = &cresult->result_lzma;
+
+    MyLzma::InStream is;
+    is.AddRef();
+    is.Init(src, src_len);
+    MyLzma::OutStream os;
+    os.AddRef();
+    os.Init(dst, *dst_len);
+    MyLzma::ProgressInfo progress;
+    progress.AddRef();
+    progress.cb = cb; // progress.Init()
+
+    NCompress::NLZMA::CEncoder enc;
+    const PROPID propIDs[8] = {
+        NCoderPropID::kPosStateBits,      // 0  pb    _posStateBits(2)
+        NCoderPropID::kLitPosBits,        // 1  lp    _numLiteralPosStateBits(0)
+        NCoderPropID::kLitContextBits,    // 2  lc    _numLiteralContextBits(3)
+        NCoderPropID::kDictionarySize,    // 3  ds
+        NCoderPropID::kAlgorithm,         // 4  fm    _fastmode
+        NCoderPropID::kNumFastBytes,      // 5  fb
+        NCoderPropID::kMatchFinderCycles, // 6  mfc   _matchFinderCycles, _cutValue
+        NCoderPropID::kMatchFinder        // 7  mf
+    };
+    PROPVARIANT pr[8];
+    const unsigned nprops = 8;
+    if (!prepare_result(res, src_len, method, level, lcconf))
+        goto error;
+    pr[0].vt = pr[1].vt = pr[2].vt = pr[3].vt = pr[4].vt = pr[5].vt = pr[6].vt = VT_UI4;
+    pr[7].vt = VT_BSTR;
+    pr[0].uintVal = res->pos_bits;
+    pr[1].uintVal = res->lit_pos_bits;
+    pr[2].uintVal = res->lit_context_bits;
+    pr[3].uintVal = res->dict_size;
+    pr[4].uintVal = res->fast_mode;
+    pr[5].uintVal = res->num_fast_bytes;
+    pr[6].uintVal = res->match_finder_cycles;
+    static const wchar_t matchfinder[] = L"BT4";
+    assert(NCompress::NLZMA::FindMatchFinder(matchfinder) >= 0);
+    pr[7].bstrVal = ACC_PCAST(BSTR, ACC_UNCONST_CAST(wchar_t *, matchfinder));
+
+    try {
+        if (enc.SetCoderProperties(propIDs, pr, nprops) != S_OK)
+            goto error;
+        // encode properties in LZMA-style (5 bytes)
+        if (enc.WriteCoderProperties(&os) != S_OK)
+            goto error;
+        if (os.overflow) {
+            // r = UPX_E_OUTPUT_OVERRUN;
+            r = UPX_E_NOT_COMPRESSIBLE;
+            goto error;
+        }
+        assert(os.b_pos == 5);
+
+        // reset and encode properties in UPX-style (2 bytes)
+        os.b_pos = 0;
+        // UPX extra stuff in first byte: 5 high bits convenience for stub decompressor
+        unsigned t = res->lit_context_bits + res->lit_pos_bits;
+        os.WriteByte(Byte((t << 3) | res->pos_bits));
+        os.WriteByte(Byte((res->lit_pos_bits << 4) | res->lit_context_bits));
+
+        // compress
+        rh = enc.Code(&is, &os, nullptr, nullptr, &progress);
+
+    } catch (...) {
+        rh = E_OUTOFMEMORY;
+    }
+
+    assert(is.b_pos <= src_len);
+    assert(os.b_pos <= *dst_len);
+    if (rh == E_OUTOFMEMORY)
+        r = UPX_E_OUT_OF_MEMORY;
+    else if (os.overflow) {
+        assert(os.b_pos == *dst_len);
+        // r = UPX_E_OUTPUT_OVERRUN;
+        r = UPX_E_NOT_COMPRESSIBLE;
+    } else if (rh == S_OK) {
+        assert(is.b_pos == src_len);
+        r = UPX_E_OK;
+    }
+
+error:
+    *dst_len = (unsigned) os.b_pos;
+    NO_printf("\nlzma_compress: %d: %u %u %u %u %u, %u - > %u\n", r, res->pos_bits,
+              res->lit_pos_bits, res->lit_context_bits, res->dict_size, res->num_probs, src_len,
+              *dst_len);
+    NO_printf("%u %u %u\n", is.__m_RefCount, os.__m_RefCount, progress.__m_RefCount);
+    return r;
+}
+
+/*************************************************************************
+// decompress
+**************************************************************************/
+
+#undef _LZMA_IN_CB
+#undef _LZMA_OUT_READ
+#undef _LZMA_PROB32
+#undef _LZMA_LOC_OPT
+#include <lzma-sdk/C/7zip/Compress/LZMA_C/LzmaDecode.h>
+#include <lzma-sdk/C/7zip/Compress/LZMA_C/LzmaDecode.c>
+
+int upx_lzma_decompress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                        int method, const upx_compress_result_t *cresult) {
+    assert(M_IS_LZMA(method));
+    // see res->num_probs above
+    COMPILE_TIME_ASSERT(sizeof(CProb) == 2)
+    COMPILE_TIME_ASSERT(LZMA_BASE_SIZE == 1846)
+    COMPILE_TIME_ASSERT(LZMA_LIT_SIZE == 768)
+
+    CLzmaDecoderState s;
+    mem_clear(&s);
+    SizeT src_out = 0, dst_out = 0;
+    int r = UPX_E_ERROR;
+    int rh;
+
+    // decode UPX-style properties (2 bytes)
+    if (src_len < 3) {
+        r = UPX_E_INPUT_OVERRUN;
+        goto error;
+    }
+    s.Properties.pb = src[0] & 7;
+    s.Properties.lp = (src[1] >> 4);
+    s.Properties.lc = src[1] & 15;
+    if (s.Properties.pb >= 5)
+        goto error;
+    if (s.Properties.lp >= 5)
+        goto error;
+    if (s.Properties.lc >= 9)
+        goto error;
+    // UPX extra stuff in first byte: 5 high bits convenience for stub decompressor
+    if ((src[0] >> 3) != s.Properties.lc + s.Properties.lp)
+        goto error;
+    src += 2;
+    src_len -= 2;
+
+    if (cresult) {
+        assert(cresult->debug.method == method);
+        assert(cresult->result_lzma.pos_bits == (unsigned) s.Properties.pb);
+        assert(cresult->result_lzma.lit_pos_bits == (unsigned) s.Properties.lp);
+        assert(cresult->result_lzma.lit_context_bits == (unsigned) s.Properties.lc);
+        assert(cresult->result_lzma.num_probs == (unsigned) LzmaGetNumProbs(&s.Properties));
+        const lzma_compress_result_t *res = &cresult->result_lzma;
+        NO_printf("\nlzma_decompress config: %u %u %u %u %u\n", res->pos_bits, res->lit_pos_bits,
+                  res->lit_context_bits, res->dict_size, res->num_probs);
+        UNUSED(res);
+    }
+    s.Probs = (CProb *) malloc(sizeof(CProb) * LzmaGetNumProbs(&s.Properties));
+    if (!s.Probs) {
+        r = UPX_E_OUT_OF_MEMORY;
+        goto error;
+    }
+    rh = LzmaDecode(&s, src, src_len, &src_out, dst, *dst_len, &dst_out);
+    assert(src_out <= src_len);
+    assert(dst_out <= *dst_len);
+    if (rh == 0) {
+        r = UPX_E_OK;
+        if (src_out != src_len)
+            r = UPX_E_INPUT_NOT_CONSUMED;
+    } else if (rh == LZMA_RESULT_INPUT_OVERRUN)
+        r = UPX_E_INPUT_OVERRUN;
+    else if (rh == LZMA_RESULT_OUTPUT_OVERRUN)
+        r = UPX_E_OUTPUT_OVERRUN;
+
+error:
+    *dst_len = dst_out;
+    free(s.Probs);
+    return r;
+}
+
+/*************************************************************************
+// test_overlap - see <ucl/ucl.h> for semantics
+**************************************************************************/
+
+int upx_lzma_test_overlap(const upx_bytep buf, const upx_bytep tbuf, unsigned src_off,
+                          unsigned src_len, unsigned *dst_len, int method,
+                          const upx_compress_result_t *cresult) {
+    assert(M_IS_LZMA(method));
+
+    MemBuffer b(src_off + src_len);
+    memcpy(b + src_off, buf + src_off, src_len);
+    unsigned saved_dst_len = *dst_len;
+    int r = upx_lzma_decompress(raw_index_bytes(b, src_off, src_len), src_len,
+                                raw_bytes(b, *dst_len), dst_len, method, cresult);
+    if (r != UPX_E_OK)
+        return r;
+    if (*dst_len != saved_dst_len)
+        return UPX_E_ERROR;
+    // NOTE: there is a very tiny possibility that decompression has
+    //   succeeded but the data is not restored correctly because of
+    //   in-place buffer overlapping, so we use an extra memcmp().
+    if (tbuf != nullptr && memcmp(tbuf, b, *dst_len) != 0)
+        return UPX_E_ERROR;
+    return UPX_E_OK;
+}
+
+/*************************************************************************
+// misc
+**************************************************************************/
+
+int upx_lzma_init(void) { return 0; }
+
+const char *upx_lzma_version_string(void) { return "4.43"; }
+
+/*************************************************************************
+// doctest checks
+**************************************************************************/
+
+TEST_CASE("upx_lzma_decompress") {
+    const byte *c_data;
+    byte d_buf[16];
+    unsigned d_len;
+    int r;
+
+    c_data = (const byte *) "\x1a\x03\x00\x7f\xed\x3c\x00\x00\x00";
+    d_len = 16;
+    r = upx_lzma_decompress(c_data, 9, d_buf, &d_len, M_LZMA, nullptr);
+    CHECK((r == 0 && d_len == 16));
+    r = upx_lzma_decompress(c_data, 8, d_buf, &d_len, M_LZMA, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 15;
+    r = upx_lzma_decompress(c_data, 9, d_buf, &d_len, M_LZMA, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+}
+
+/* vim:set ts=4 sw=4 et: */

src/compress/compress_ucl.cpp

@@ -0,0 +1,368 @@
+/* compress_ucl.cpp --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+#include "compress.h"
+
+/*************************************************************************
+//
+**************************************************************************/
+
+static int convert_errno_from_ucl(int r) {
+    switch (r) {
+    case UCL_E_OK:
+        return UPX_E_OK;
+    case UCL_E_ERROR:
+        return UPX_E_ERROR;
+    case UCL_E_OUT_OF_MEMORY:
+        return UPX_E_OUT_OF_MEMORY;
+    case UCL_E_NOT_COMPRESSIBLE:
+        return UPX_E_NOT_COMPRESSIBLE;
+    case UCL_E_INPUT_OVERRUN:
+        return UPX_E_INPUT_OVERRUN;
+    case UCL_E_OUTPUT_OVERRUN:
+        return UPX_E_OUTPUT_OVERRUN;
+    case UCL_E_LOOKBEHIND_OVERRUN:
+        return UPX_E_LOOKBEHIND_OVERRUN;
+    case UCL_E_EOF_NOT_FOUND:
+        return UPX_E_EOF_NOT_FOUND;
+    case UCL_E_INPUT_NOT_CONSUMED:
+        return UPX_E_INPUT_NOT_CONSUMED;
+    case UCL_E_INVALID_ARGUMENT:
+        return UPX_E_INVALID_ARGUMENT;
+    // UCL extra:
+    case UCL_E_OVERLAP_OVERRUN:
+        return UPX_E_ERROR;
+    default:
+        break;
+    }
+    return UPX_E_ERROR;
+}
+
+extern "C" {
+static void __UCL_CDECL wrap_nprogress_ucl(ucl_uint a, ucl_uint b, int state, ucl_voidp user) {
+    if (state != -1 && state != 3)
+        return;
+    upx_callback_p cb = (upx_callback_p) user;
+    if (cb && cb->nprogress)
+        cb->nprogress(cb, a, b);
+}
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_ucl_compress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                     upx_callback_p cb_parm, int method, int level,
+                     const upx_compress_config_t *cconf_parm, upx_compress_result_t *cresult) {
+    int r;
+    assert(level > 0);
+    assert(cresult != nullptr);
+
+    COMPILE_TIME_ASSERT(sizeof(ucl_compress_config_t) == sizeof(REAL_ucl_compress_config_t))
+
+    ucl_progress_callback_t cb;
+    cb.callback = nullptr;
+    cb.user = nullptr;
+    if (cb_parm && cb_parm->nprogress) {
+        cb.callback = wrap_nprogress_ucl;
+        cb.user = cb_parm;
+    }
+
+    ucl_compress_config_t cconf;
+    cconf.reset();
+    if (cconf_parm) {
+        // cconf = cconf_parm->conf_ucl; // struct copy
+        memcpy(&cconf, &cconf_parm->conf_ucl, sizeof(cconf));
+    }
+
+    ucl_uint *const res = cresult->result_ucl.result;
+    // assume no info available - fill in worst case results
+    // res[0] = 1;        // min_offset_found - NOT USED
+    res[1] = src_len - 1; // max_offset_found
+    // res[2] = 2;        // min_match_found - NOT USED
+    res[3] = src_len - 1; // max_match_found
+    // res[4] = 1;        // min_run_found - NOT USED
+    res[5] = src_len; // max_run_found
+    res[6] = 1;       // first_offset_found
+    // res[7] = 999999;   // same_match_offsets_found - NOT USED
+
+    // prepare bit-buffer settings
+    cconf.bb_endian = 0;
+    cconf.bb_size = 0;
+    if (method >= M_NRV2B_LE32 && method <= M_NRV2E_LE16) {
+        static const upx_uint8_t sizes[3] = {32, 8, 16};
+        cconf.bb_size = sizes[(method - M_NRV2B_LE32) % 3];
+    } else {
+        throwInternalError("unknown compression method");
+        return UPX_E_ERROR;
+    }
+
+    // optimize compression params
+    if (level <= 3 && cconf.max_offset == UCL_UINT_MAX)
+        cconf.max_offset = 8 * 1024 - 1;
+    else if (level == 4 && cconf.max_offset == UCL_UINT_MAX)
+        cconf.max_offset = 32 * 1024 - 1;
+
+    if M_IS_NRV2B (method)
+        r = ucl_nrv2b_99_compress(src, src_len, dst, dst_len, &cb, level, &cconf, res);
+    else if M_IS_NRV2D (method)
+        r = ucl_nrv2d_99_compress(src, src_len, dst, dst_len, &cb, level, &cconf, res);
+    else if M_IS_NRV2E (method)
+        r = ucl_nrv2e_99_compress(src, src_len, dst, dst_len, &cb, level, &cconf, res);
+    else {
+        throwInternalError("unknown compression method");
+        return UPX_E_ERROR;
+    }
+
+    // make sure first_offset_found is set
+    if (res[6] == 0)
+        res[6] = 1;
+
+    return convert_errno_from_ucl(r);
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_ucl_decompress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                       int method, const upx_compress_result_t *cresult) {
+    int r;
+
+    switch (method) {
+    case M_NRV2B_8:
+        r = ucl_nrv2b_decompress_safe_8(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2B_LE16:
+        r = ucl_nrv2b_decompress_safe_le16(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2B_LE32:
+        r = ucl_nrv2b_decompress_safe_le32(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2D_8:
+        r = ucl_nrv2d_decompress_safe_8(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2D_LE16:
+        r = ucl_nrv2d_decompress_safe_le16(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2D_LE32:
+        r = ucl_nrv2d_decompress_safe_le32(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2E_8:
+        r = ucl_nrv2e_decompress_safe_8(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2E_LE16:
+        r = ucl_nrv2e_decompress_safe_le16(src, src_len, dst, dst_len, nullptr);
+        break;
+    case M_NRV2E_LE32:
+        r = ucl_nrv2e_decompress_safe_le32(src, src_len, dst, dst_len, nullptr);
+        break;
+    default:
+        throwInternalError("unknown decompression method");
+        return UPX_E_ERROR;
+    }
+
+    UNUSED(cresult);
+    return convert_errno_from_ucl(r);
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_ucl_test_overlap(const upx_bytep buf, const upx_bytep tbuf, unsigned src_off,
+                         unsigned src_len, unsigned *dst_len, int method,
+                         const upx_compress_result_t *cresult) {
+    int r;
+    UNUSED(tbuf); // not needed for UCL
+
+    switch (method) {
+    case M_NRV2B_8:
+        r = ucl_nrv2b_test_overlap_8(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2B_LE16:
+        r = ucl_nrv2b_test_overlap_le16(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2B_LE32:
+        r = ucl_nrv2b_test_overlap_le32(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2D_8:
+        r = ucl_nrv2d_test_overlap_8(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2D_LE16:
+        r = ucl_nrv2d_test_overlap_le16(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2D_LE32:
+        r = ucl_nrv2d_test_overlap_le32(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2E_8:
+        r = ucl_nrv2e_test_overlap_8(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2E_LE16:
+        r = ucl_nrv2e_test_overlap_le16(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    case M_NRV2E_LE32:
+        r = ucl_nrv2e_test_overlap_le32(buf, src_off, src_len, dst_len, nullptr);
+        break;
+    default:
+        throwInternalError("unknown decompression method");
+        return UPX_E_ERROR;
+    }
+
+    UNUSED(cresult);
+    return convert_errno_from_ucl(r);
+}
+
+/*************************************************************************
+// misc
+**************************************************************************/
+
+extern "C" {
+static ucl_voidp __UCL_CDECL my_malloc(ucl_uint n) { return upx_calloc(n, 1); }
+static void __UCL_CDECL my_free(ucl_voidp p) { free(p); }
+} // extern "C"
+
+int upx_ucl_init(void) {
+    if (ucl_init() != UCL_E_OK)
+        return -1;
+    if (UCL_VERSION != ucl_version() || strcmp(UCL_VERSION_STRING, ucl_version_string()) != 0)
+        return -2;
+    ucl_set_malloc_hooks(my_malloc, my_free);
+    return 0;
+}
+
+const char *upx_ucl_version_string(void) { return ucl_version_string(); }
+
+unsigned upx_ucl_adler32(const void *buf, unsigned len, unsigned adler) {
+    return ucl_adler32(adler, (const ucl_bytep) buf, len);
+}
+
+#if 0 // UNUSED
+unsigned upx_ucl_crc32(const void *buf, unsigned len, unsigned crc) {
+    return ucl_crc32(crc, (const ucl_bytep) buf, len);
+}
+#endif
+
+/*************************************************************************
+// doctest checks
+**************************************************************************/
+
+#if DEBUG && !defined(DOCTEST_CONFIG_DISABLE) && 1
+
+#include "../util/membuffer.h"
+
+static bool check_ucl(const int method, const unsigned expected_c_len) {
+    const unsigned u_len = 16384;
+    const unsigned c_extra = 4096;
+    MemBuffer u_buf, c_buf, d_buf;
+    unsigned c_len, d_len;
+    upx_compress_result_t cresult;
+    int r;
+    const int level = 3; // don't waste time
+
+    u_buf.alloc(u_len);
+    memset(u_buf, 0, u_len);
+    c_buf.allocForCompression(u_len, c_extra);
+    d_buf.allocForDecompression(u_len);
+
+    c_len = c_buf.getSize() - c_extra;
+    r = upx_ucl_compress(raw_bytes(u_buf, u_len), u_len, raw_index_bytes(c_buf, c_extra, c_len),
+                         &c_len, nullptr, method, level, NULL_cconf, &cresult);
+    if (r != 0 || c_len != expected_c_len)
+        return false;
+
+    d_len = d_buf.getSize();
+    r = upx_ucl_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                           &d_len, method, nullptr);
+    if (r != 0 || d_len != u_len || memcmp(u_buf, d_buf, u_len) != 0)
+        return false;
+
+    d_len = u_len - 1;
+    r = upx_ucl_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                           &d_len, method, nullptr);
+    if (r == 0)
+        return false;
+
+    // TODO: rewrite Packer::findOverlapOverhead() so that we can test it here
+    // unsigned x_len = d_len;
+    // r = upx_ucl_test_overlap(c_buf, u_buf, c_extra, c_len, &x_len, method, nullptr);
+    return true;
+}
+
+TEST_CASE("compress_ucl") {
+    CHECK(check_ucl(M_NRV2B_8, 34));
+    CHECK(check_ucl(M_NRV2B_LE16, 34));
+    CHECK(check_ucl(M_NRV2B_LE32, 34));
+    CHECK(check_ucl(M_NRV2D_8, 32));
+    CHECK(check_ucl(M_NRV2D_LE16, 32));
+    CHECK(check_ucl(M_NRV2D_LE32, 34));
+    CHECK(check_ucl(M_NRV2E_8, 32));
+    CHECK(check_ucl(M_NRV2E_LE16, 32));
+    CHECK(check_ucl(M_NRV2E_LE32, 34));
+}
+
+#endif // DEBUG
+
+TEST_CASE("upx_ucl_decompress") {
+    const byte *c_data;
+    byte d_buf[16];
+    unsigned d_len;
+    int r;
+
+    c_data = (const byte *) "\x92\xff\x10\x00\x00\x00\x00\x00\x48\xff";
+    d_len = 16;
+    r = upx_ucl_decompress(c_data, 10, d_buf, &d_len, M_NRV2B_8, nullptr);
+    CHECK((r == 0 && d_len == 16));
+    r = upx_ucl_decompress(c_data, 9, d_buf, &d_len, M_NRV2B_8, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 15;
+    r = upx_ucl_decompress(c_data, 10, d_buf, &d_len, M_NRV2B_8, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+
+    c_data = (const byte *) "\x92\xff\x10\x92\x49\x24\x92\xa0\xff";
+    d_len = 16;
+    r = upx_ucl_decompress(c_data, 9, d_buf, &d_len, M_NRV2D_8, nullptr);
+    CHECK((r == 0 && d_len == 16));
+    r = upx_ucl_decompress(c_data, 8, d_buf, &d_len, M_NRV2D_8, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 15;
+    r = upx_ucl_decompress(c_data, 9, d_buf, &d_len, M_NRV2D_8, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+
+    c_data = (const byte *) "\x90\xff\xb0\x92\x49\x24\x92\xa0\xff";
+    d_len = 16;
+    r = upx_ucl_decompress(c_data, 9, d_buf, &d_len, M_NRV2E_8, nullptr);
+    CHECK((r == 0 && d_len == 16));
+    r = upx_ucl_decompress(c_data, 8, d_buf, &d_len, M_NRV2E_8, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 15;
+    r = upx_ucl_decompress(c_data, 9, d_buf, &d_len, M_NRV2E_8, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+}
+
+/* vim:set ts=4 sw=4 et: */

src/compress/compress_zlib.cpp

@@ -0,0 +1,310 @@
+/* compress_zlib.cpp --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+#include "compress.h"
+#include "../util/membuffer.h"
+// NOLINTBEGIN(clang-analyzer-optin.performance.Padding)
+#define ZLIB_CONST 1
+#include <zlib/zlib.h>
+#include <zlib/deflate.h>
+// NOLINTEND(clang-analyzer-optin.performance.Padding)
+
+void zlib_compress_config_t::reset() noexcept {
+    mem_clear(this);
+    mem_level.reset();
+    window_bits.reset();
+    strategy.reset();
+}
+
+static int convert_errno_from_zlib(int zr) {
+    switch (zr) {
+    case Z_OK:
+        return UPX_E_OK;
+    // positive values
+    case Z_STREAM_END:
+        return UPX_E_ERROR;
+    case Z_NEED_DICT:
+        return UPX_E_ERROR;
+    // negative values
+    case Z_ERRNO:
+        return UPX_E_ERROR;
+    case Z_STREAM_ERROR:
+        return UPX_E_ERROR;
+    case Z_DATA_ERROR:
+        return UPX_E_ERROR;
+    case Z_MEM_ERROR:
+        return UPX_E_OUT_OF_MEMORY;
+    case Z_BUF_ERROR:
+        return UPX_E_OUTPUT_OVERRUN;
+    case Z_VERSION_ERROR:
+        return UPX_E_ERROR;
+    case -7: // UPX extra
+        return UPX_E_INPUT_OVERRUN;
+    default:
+        break;
+    }
+    return UPX_E_ERROR;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_zlib_compress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                      upx_callback_p cb_parm, int method, int level,
+                      const upx_compress_config_t *cconf_parm, upx_compress_result_t *cresult) {
+    assert(method == M_DEFLATE);
+    assert(level > 0);
+    assert(cresult != nullptr);
+    UNUSED(cb_parm);
+    int r = UPX_E_ERROR;
+    int zr;
+    const zlib_compress_config_t *const lcconf = cconf_parm ? &cconf_parm->conf_zlib : nullptr;
+    zlib_compress_result_t *const res = &cresult->result_zlib;
+
+    if (level == 10)
+        level = 9;
+
+    zlib_compress_config_t::mem_level_t mem_level;
+    zlib_compress_config_t::window_bits_t window_bits;
+    zlib_compress_config_t::strategy_t strategy;
+    // cconf overrides
+    if (lcconf) {
+        oassign(mem_level, lcconf->mem_level);
+        oassign(window_bits, lcconf->window_bits);
+        oassign(strategy, lcconf->strategy);
+    }
+
+    res->dummy = 0;
+
+    z_stream s;
+    s.zalloc = (alloc_func) nullptr;
+    s.zfree = (free_func) nullptr;
+    s.next_in = src;
+    s.avail_in = src_len;
+    s.next_out = dst;
+    s.avail_out = *dst_len;
+    s.total_in = s.total_out = 0;
+
+    zr = (int) deflateInit2(&s, level, Z_DEFLATED, 0 - (int) window_bits, mem_level, strategy);
+    if (zr != Z_OK)
+        goto error;
+    assert(s.state->level == level);
+    zr = deflate(&s, Z_FINISH);
+    if (zr != Z_STREAM_END)
+        goto error;
+    zr = deflateEnd(&s);
+    if (zr != Z_OK)
+        goto error;
+    r = UPX_E_OK;
+    goto done;
+error:
+    (void) deflateEnd(&s);
+    r = convert_errno_from_zlib(zr);
+    if (r == UPX_E_OK)
+        r = UPX_E_ERROR;
+done:
+    if (r == UPX_E_OK) {
+        if (s.avail_in != 0 || s.total_in != src_len)
+            r = UPX_E_ERROR;
+    }
+    assert(s.total_in <= src_len);
+    assert(s.total_out <= *dst_len);
+    *dst_len = s.total_out;
+    return r;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_zlib_decompress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                        int method, const upx_compress_result_t *cresult) {
+    assert(method == M_DEFLATE);
+    UNUSED(method);
+    UNUSED(cresult);
+    int r = UPX_E_ERROR;
+    int zr;
+
+    z_stream s;
+    s.zalloc = (alloc_func) nullptr;
+    s.zfree = (free_func) nullptr;
+    s.next_in = src;
+    s.avail_in = src_len;
+    s.next_out = dst;
+    s.avail_out = *dst_len;
+    s.total_in = s.total_out = 0;
+
+    zr = inflateInit2(&s, -15);
+    if (zr != Z_OK)
+        goto error;
+    zr = inflate(&s, Z_FINISH);
+    if (zr != Z_STREAM_END) {
+        if (zr == Z_BUF_ERROR && s.avail_in == 0)
+            zr = -7; // UPX extra
+        goto error;
+    }
+    zr = inflateEnd(&s);
+    if (zr != Z_OK)
+        goto error;
+    r = UPX_E_OK;
+    goto done;
+error:
+    (void) inflateEnd(&s);
+    r = convert_errno_from_zlib(zr);
+    if (r == UPX_E_OK)
+        r = UPX_E_ERROR;
+done:
+    if (r == UPX_E_OK) {
+        if (s.avail_in != 0 || s.total_in != src_len)
+            r = UPX_E_INPUT_NOT_CONSUMED;
+    }
+    assert(s.total_in <= src_len);
+    assert(s.total_out <= *dst_len);
+    *dst_len = s.total_out;
+    return r;
+}
+
+/*************************************************************************
+// test_overlap - see <ucl/ucl.h> for semantics
+**************************************************************************/
+
+int upx_zlib_test_overlap(const upx_bytep buf, const upx_bytep tbuf, unsigned src_off,
+                          unsigned src_len, unsigned *dst_len, int method,
+                          const upx_compress_result_t *cresult) {
+    assert(method == M_DEFLATE);
+
+    MemBuffer b(src_off + src_len);
+    memcpy(b + src_off, buf + src_off, src_len);
+    unsigned saved_dst_len = *dst_len;
+    int r = upx_zlib_decompress(raw_index_bytes(b, src_off, src_len), src_len,
+                                raw_bytes(b, *dst_len), dst_len, method, cresult);
+    if (r != UPX_E_OK)
+        return r;
+    if (*dst_len != saved_dst_len)
+        return UPX_E_ERROR;
+    // NOTE: there is a very tiny possibility that decompression has
+    //   succeeded but the data is not restored correctly because of
+    //   in-place buffer overlapping, so we use an extra memcmp().
+    if (tbuf != nullptr && memcmp(tbuf, b, *dst_len) != 0)
+        return UPX_E_ERROR;
+    return UPX_E_OK;
+}
+
+/*************************************************************************
+// misc
+**************************************************************************/
+
+int upx_zlib_init(void) {
+    if (strcmp(ZLIB_VERSION, zlibVersion()) != 0)
+        return -2;
+    return 0;
+}
+
+const char *upx_zlib_version_string(void) { return zlibVersion(); }
+
+#if 0 // UNUSED
+unsigned upx_zlib_adler32(const void *buf, unsigned len, unsigned adler) {
+    return adler32(adler, (const Bytef *) buf, len);
+}
+#endif
+
+#if 0 // UNUSED
+unsigned upx_zlib_crc32(const void *buf, unsigned len, unsigned crc) {
+    return crc32(crc, (const Bytef *) buf, len);
+}
+#endif
+
+/*************************************************************************
+// doctest checks
+**************************************************************************/
+
+#if DEBUG && !defined(DOCTEST_CONFIG_DISABLE) && 1
+
+static bool check_zlib(const int method, const int level, const unsigned expected_c_len) {
+    const unsigned u_len = 16384;
+    const unsigned c_extra = 4096;
+    MemBuffer u_buf, c_buf, d_buf;
+    unsigned c_len, d_len;
+    upx_compress_result_t cresult;
+    int r;
+
+    u_buf.alloc(u_len);
+    memset(u_buf, 0, u_len);
+    c_buf.allocForCompression(u_len, c_extra);
+    d_buf.allocForDecompression(u_len);
+
+    c_len = c_buf.getSize() - c_extra;
+    r = upx_zlib_compress(raw_bytes(u_buf, u_len), u_len, raw_index_bytes(c_buf, c_extra, c_len),
+                          &c_len, nullptr, method, level, NULL_cconf, &cresult);
+    if (r != 0 || c_len != expected_c_len)
+        return false;
+
+    d_len = d_buf.getSize();
+    r = upx_zlib_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                            &d_len, method, nullptr);
+    if (r != 0 || d_len != u_len || memcmp(u_buf, d_buf, u_len) != 0)
+        return false;
+
+    d_len = u_len - 1;
+    r = upx_zlib_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                            &d_len, method, nullptr);
+    if (r == 0)
+        return false;
+
+    // TODO: rewrite Packer::findOverlapOverhead() so that we can test it here
+    // unsigned x_len = d_len;
+    // r = upx_zlib_test_overlap(c_buf, u_buf, c_extra, c_len, &x_len, method, nullptr);
+    return true;
+}
+
+TEST_CASE("compress_zlib") {
+    CHECK(check_zlib(M_DEFLATE, 1, 89));
+    CHECK(check_zlib(M_DEFLATE, 3, 89));
+    CHECK(check_zlib(M_DEFLATE, 5, 33));
+}
+
+#endif // DEBUG
+
+TEST_CASE("upx_zlib_decompress") {
+    const byte *c_data;
+    byte d_buf[16];
+    unsigned d_len;
+    int r;
+
+    c_data = (const byte *) "\xfb\xff\x1f\x15\x00\x00";
+    d_len = 16;
+    r = upx_zlib_decompress(c_data, 6, d_buf, &d_len, M_DEFLATE, nullptr);
+    CHECK((r == 0 && d_len == 16));
+    r = upx_zlib_decompress(c_data, 5, d_buf, &d_len, M_DEFLATE, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 15;
+    r = upx_zlib_decompress(c_data, 6, d_buf, &d_len, M_DEFLATE, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+}
+
+/* vim:set ts=4 sw=4 et: */

src/compress/compress_zstd.cpp

@@ -0,0 +1,228 @@
+/* compress_zstd.cpp --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer
+   <markus@oberhumer.com>
+ */
+
+#include "../conf.h"
+
+void zstd_compress_config_t::reset() noexcept { mem_clear(this); }
+
+#if WITH_ZSTD
+#include "compress.h"
+#include "../util/membuffer.h"
+#include <zstd/lib/zstd.h>
+#include <zstd/lib/zstd_errors.h>
+#include <zstd/lib/compress/hist.h>
+
+static int convert_errno_from_zstd(size_t zr) {
+    const ZSTD_ErrorCode ze = ZSTD_getErrorCode(zr);
+    switch (ze) {
+    case ZSTD_error_memory_allocation:
+        return UPX_E_OUT_OF_MEMORY;
+    case ZSTD_error_srcSize_wrong:
+        return UPX_E_INPUT_OVERRUN;
+    case ZSTD_error_dstSize_tooSmall:
+        return UPX_E_OUTPUT_OVERRUN;
+    default:
+        break;
+    }
+    return UPX_E_ERROR;
+}
+
+/*************************************************************************
+// TODO later: use advanced compression API for compression finetuning
+**************************************************************************/
+
+int upx_zstd_compress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                      upx_callback_p cb_parm, int method, int level,
+                      const upx_compress_config_t *cconf_parm, upx_compress_result_t *cresult) {
+    assert(method == M_ZSTD);
+    assert(level > 0);
+    assert(cresult != nullptr);
+    UNUSED(cb_parm);
+    int r = UPX_E_ERROR;
+    size_t zr;
+    const zstd_compress_config_t *const lcconf = cconf_parm ? &cconf_parm->conf_zstd : nullptr;
+    zstd_compress_result_t *const res = &cresult->result_zstd;
+
+    // TODO later: map level 1..10 to zstd-level 1..22
+    if (level == 10)
+        level = 22;
+
+    // cconf overrides
+    if (lcconf) {
+        UNUSED(lcconf);
+    }
+
+    res->dummy = 0;
+
+    zr = ZSTD_compress(dst, *dst_len, src, src_len, level);
+    if (ZSTD_isError(zr)) {
+        *dst_len = 0; // TODO ???
+        r = convert_errno_from_zstd(zr);
+        assert(r != UPX_E_OK);
+    } else {
+        assert(zr <= *dst_len);
+        *dst_len = (unsigned) zr;
+        r = UPX_E_OK;
+    }
+
+    return r;
+}
+
+/*************************************************************************
+//
+**************************************************************************/
+
+int upx_zstd_decompress(const upx_bytep src, unsigned src_len, upx_bytep dst, unsigned *dst_len,
+                        int method, const upx_compress_result_t *cresult) {
+    assert(method == M_ZSTD);
+    UNUSED(method);
+    UNUSED(cresult);
+    int r = UPX_E_ERROR;
+    size_t zr;
+
+    zr = ZSTD_decompress(dst, *dst_len, src, src_len);
+    if (ZSTD_isError(zr)) {
+        *dst_len = 0; // TODO ???
+        r = convert_errno_from_zstd(zr);
+        assert(r != UPX_E_OK);
+    } else {
+        assert(zr <= *dst_len);
+        *dst_len = (unsigned) zr;
+        r = UPX_E_OK;
+    }
+
+    return r;
+}
+
+/*************************************************************************
+// test_overlap - see <ucl/ucl.h> for semantics
+**************************************************************************/
+
+int upx_zstd_test_overlap(const upx_bytep buf, const upx_bytep tbuf, unsigned src_off,
+                          unsigned src_len, unsigned *dst_len, int method,
+                          const upx_compress_result_t *cresult) {
+    assert(method == M_ZSTD);
+
+    MemBuffer b(src_off + src_len);
+    memcpy(b + src_off, buf + src_off, src_len);
+    unsigned saved_dst_len = *dst_len;
+    int r = upx_zstd_decompress(raw_index_bytes(b, src_off, src_len), src_len,
+                                raw_bytes(b, *dst_len), dst_len, method, cresult);
+    if (r != UPX_E_OK)
+        return r;
+    if (*dst_len != saved_dst_len)
+        return UPX_E_ERROR;
+    // NOTE: there is a very tiny possibility that decompression has
+    //   succeeded but the data is not restored correctly because of
+    //   in-place buffer overlapping, so we use an extra memcmp().
+    if (tbuf != nullptr && memcmp(tbuf, b, *dst_len) != 0)
+        return UPX_E_ERROR;
+    return UPX_E_OK;
+}
+
+/*************************************************************************
+// misc
+**************************************************************************/
+
+int upx_zstd_init(void) {
+    if (strcmp(ZSTD_VERSION_STRING, ZSTD_versionString()) != 0)
+        return -2;
+    return 0;
+}
+
+const char *upx_zstd_version_string(void) { return ZSTD_VERSION_STRING; }
+
+/*************************************************************************
+// doctest checks
+**************************************************************************/
+
+#if DEBUG && !defined(DOCTEST_CONFIG_DISABLE) && 1
+
+static bool check_zstd(const int method, const int level, const unsigned expected_c_len) {
+    const unsigned u_len = 16384;
+    const unsigned c_extra = 4096;
+    MemBuffer u_buf, c_buf, d_buf;
+    unsigned c_len, d_len;
+    upx_compress_result_t cresult;
+    int r;
+
+    u_buf.alloc(u_len);
+    memset(u_buf, 0, u_len);
+    c_buf.allocForCompression(u_len, c_extra);
+    d_buf.allocForDecompression(u_len);
+
+    c_len = c_buf.getSize() - c_extra;
+    r = upx_zstd_compress(raw_bytes(u_buf, u_len), u_len, raw_index_bytes(c_buf, c_extra, c_len),
+                          &c_len, nullptr, method, level, NULL_cconf, &cresult);
+    if (r != 0 || c_len != expected_c_len)
+        return false;
+
+    d_len = d_buf.getSize();
+    r = upx_zstd_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                            &d_len, method, nullptr);
+    if (r != 0 || d_len != u_len || memcmp(u_buf, d_buf, u_len) != 0)
+        return false;
+
+    d_len = u_len - 1;
+    r = upx_zstd_decompress(raw_index_bytes(c_buf, c_extra, c_len), c_len, raw_bytes(d_buf, d_len),
+                            &d_len, method, nullptr);
+    if (r == 0)
+        return false;
+
+    // TODO: rewrite Packer::findOverlapOverhead() so that we can test it here
+    // unsigned x_len = d_len;
+    // r = upx_zstd_test_overlap(c_buf, u_buf, c_extra, c_len, &x_len, method, nullptr);
+    return true;
+}
+
+TEST_CASE("compress_zstd") {
+    CHECK(check_zstd(M_ZSTD, 1, 19));
+    CHECK(check_zstd(M_ZSTD, 3, 19));
+    CHECK(check_zstd(M_ZSTD, 5, 19));
+}
+
+#endif // DEBUG
+
+TEST_CASE("upx_zstd_decompress") {
+    const byte *c_data;
+    byte d_buf[32];
+    unsigned d_len;
+    int r;
+
+    c_data = (const byte *) "\x28\xb5\x2f\xfd\x20\x20\x3d\x00\x00\x08\xff\x01\x00\x34\x4e\x08";
+    d_len = 32;
+    r = upx_zstd_decompress(c_data, 16, d_buf, &d_len, M_ZSTD, nullptr);
+    CHECK((r == 0 && d_len == 32));
+    r = upx_zstd_decompress(c_data, 15, d_buf, &d_len, M_ZSTD, nullptr);
+    CHECK(r == UPX_E_INPUT_OVERRUN);
+    d_len = 31;
+    r = upx_zstd_decompress(c_data, 16, d_buf, &d_len, M_ZSTD, nullptr);
+    CHECK(r == UPX_E_OUTPUT_OVERRUN);
+}
+
+#endif // WITH_ZSTD
+
+/* vim:set ts=4 sw=4 et: */

src/config_h/linux.h

@@ -1,240 +0,0 @@
-/* pseudo <config.h> for Linux */
-
-#ifndef __UPX_CONFIG_H
-#define __UPX_CONFIG_H
-
-/* $TOP$ */
-
-/* Define to empty if the keyword does not work.  */
-/* #undef const */
-
-/* Define if your C compiler doesn't accept -c and -o together.  */
-/* #undef NO_MINUS_C_MINUS_O */
-
-/* Define as the return type of signal handlers (int or void).  */
-#define RETSIGTYPE void
-
-/* Define to `unsigned' if <sys/types.h> doesn't define.  */
-/* #undef size_t */
-
-/* Define if you have the ANSI C header files.  */
-#define STDC_HEADERS 1
-
-/* Define if you can safely include both <sys/time.h> and <time.h>.  */
-#define TIME_WITH_SYS_TIME 1
-
-/* Define if your memcmp is broken.  */
-/* #undef NO_MEMCMP */
-
-/* Define to `long' if <stddef.h> doesn't define.  */
-/* #undef ptrdiff_t */
-
-/* The number of bytes in a ptrdiff_t.  */
-#define SIZEOF_PTRDIFF_T 4
-
-/* The number of bytes in a size_t.  */
-#define SIZEOF_SIZE_T 4
-
-/* Define when using the dmalloc package.  */
-/* #undef WITH_DMALLOC */
-
-/* Define if you have the access function.  */
-#define HAVE_ACCESS 1
-
-/* Define if you have the atoi function.  */
-#define HAVE_ATOI 1
-
-/* Define if you have the chmod function.  */
-#define HAVE_CHMOD 1
-
-/* Define if you have the chown function.  */
-#define HAVE_CHOWN 1
-
-/* Define if you have the ctime function.  */
-#define HAVE_CTIME 1
-
-/* Define if you have the difftime function.  */
-#define HAVE_DIFFTIME 1
-
-/* Define if you have the fchmod function.  */
-#define HAVE_FCHMOD 1
-
-/* Define if you have the fileno function.  */
-#define HAVE_FILENO 1
-
-/* Define if you have the fstat function.  */
-#define HAVE_FSTAT 1
-
-/* Define if you have the XXX function.  */
-#define HAVE_GETPID 1
-
-/* Define if you have the XXX function.  */
-#define HAVE_GETTIMEOFDAY 1
-
-/* Define if you have the getumask function.  */
-/* #undef HAVE_GETUMASK */
-
-/* Define if you have the gmtime function.  */
-#define HAVE_GMTIME 1
-
-/* Define if you have the index function.  */
-#define HAVE_INDEX 1
-
-/* Define if you have the isatty function.  */
-#define HAVE_ISATTY 1
-
-/* Define if you have the lstat function.  */
-#define HAVE_LSTAT 1
-
-/* Define if you have the localtime function.  */
-#define HAVE_LOCALTIME 1
-
-/* Define if you have the memcmp function.  */
-#define HAVE_MEMCMP 1
-
-/* Define if you have the memcpy function.  */
-#define HAVE_MEMCPY 1
-
-/* Define if you have the memmove function.  */
-#define HAVE_MEMMOVE 1
-
-/* Define if you have the memset function.  */
-#define HAVE_MEMSET 1
-
-/* Define if you have the mktime function.  */
-#define HAVE_MKTIME 1
-
-/* Define if you have the setmode function.  */
-/* #undef HAVE_SETMODE */
-
-/* Define if you have the stat function.  */
-#define HAVE_STAT 1
-
-/* Define if you have the strcasecmp function.  */
-#define HAVE_STRCASECMP 1
-
-/* Define if you have the strchr function.  */
-#define HAVE_STRCHR 1
-
-/* Define if you have the strdup function.  */
-#define HAVE_STRDUP 1
-
-/* Define if you have the strftime function.  */
-#define HAVE_STRFTIME 1
-
-/* Define if you have the stricmp function.  */
-/* #undef HAVE_STRICMP */
-
-/* Define if you have the strncasecmp function.  */
-#define HAVE_STRNCASECMP 1
-
-/* Define if you have the strnicmp function.  */
-/* #undef HAVE_STRNICMP */
-
-/* Define if you have the strstr function.  */
-#define HAVE_STRSTR 1
-
-/* Define if you have the tzset function.  */
-#define HAVE_TZSET 1
-
-/* Define if you have the umask function.  */
-#define HAVE_UMASK 1
-
-/* Define if you have the utime function.  */
-#define HAVE_UTIME 1
-
-/* Define if you have the vsnprintf function.  */
-#define HAVE_VSNPRINTF 1
-
-/* Define if you have the <assert.h> header file.  */
-#define HAVE_ASSERT_H 1
-
-/* Define if you have the <ctype.h> header file.  */
-#define HAVE_CTYPE_H 1
-
-/* Define if you have the <curses.h> header file.  */
-#define HAVE_CURSES_H 1
-
-/* Define if you have the <limits.h> header file.  */
-#define HAVE_LIMITS_H 1
-
-/* Define if you have the <linux/kd.h> header file.  */
-#define HAVE_LINUX_KD_H 1
-
-/* Define if you have the <linux/kdev_t.h> header file.  */
-#define HAVE_LINUX_KDEV_T_H 1
-
-/* Define if you have the <linux/major.h> header file.  */
-#define HAVE_LINUX_MAJOR_H 1
-
-/* Define if you have the <memory.h> header file.  */
-#define HAVE_MEMORY_H 1
-
-/* Define if you have the <ncurses.h> header file.  */
-#define HAVE_NCURSES_H 1
-
-/* Define if you have the <signal.h> header file.  */
-#define HAVE_SIGNAL_H 1
-
-/* Define if you have the <stddef.h> header file.  */
-#define HAVE_STDDEF_H 1
-
-/* Define if you have the <sys/param.h> header file.  */
-#define HAVE_SYS_PARAM_H 1
-
-/* Define if you have the <sys/resource.h> header file.  */
-#define HAVE_SYS_RESOURCE_H 1
-
-/* Define if you have the <sys/time.h> header file.  */
-#define HAVE_SYS_TIME_H 1
-
-/* Define if you have the <sys/times.h> header file.  */
-#define HAVE_SYS_TIMES_H 1
-
-/* Define if you have the <sys/utime.h> header file.  */
-/* #undef HAVE_SYS_UTIME_H */
-
-/* Define if you have the <time.h> header file.  */
-#define HAVE_TIME_H 1
-
-/* Define if you have the <unistd.h> header file.  */
-#define HAVE_UNISTD_H 1
-
-/* Define if you have the <utime.h> header file.  */
-#define HAVE_UTIME_H 1
-
-/* $BOTTOM$ */
-
-#if defined(HAVE_GMTIME) && !defined(TIME_WITH_SYS_TIME)
-#  undef /**/ HAVE_GMTIME
-#endif
-
-#if defined(HAVE_LOCALTIME) && !defined(TIME_WITH_SYS_TIME)
-#  undef /**/ HAVE_LOCALTIME
-#endif
-
-#if defined(HAVE_STRFTIME) && !defined(TIME_WITH_SYS_TIME)
-#  undef /**/ HAVE_STRFTIME
-#endif
-
-#if defined(HAVE_SYS_RESOURCE_H) && !defined(TIME_WITH_SYS_TIME)
-#  undef /**/ HAVE_SYS_RESOURCE_H
-#endif
-
-#if defined(HAVE_SYS_TIMES_H) && !defined(TIME_WITH_SYS_TIME)
-#  undef /**/ HAVE_SYS_TIMES_H
-#endif
-
-#if (SIZEOF_PTRDIFF_T <= 0)
-#  undef /**/ SIZEOF_PTRDIFF_T
-#endif
-
-#if (SIZEOF_SIZE_T <= 0)
-#  undef /**/ SIZEOF_SIZE_T
-#endif
-
-#endif /* already included */
-
-/*
-vi:ts=4
-*/

src/console.h

@@ -1,191 +0,0 @@
-/* console.h --
-
-   This file is part of the UPX executable compressor.
-
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
-   All Rights Reserved.
-
-   UPX and the UCL library are free software; you can redistribute them
-   and/or modify them under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
-
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.
-   If not, write to the Free Software Foundation, Inc.,
-   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-
-   Markus F.X.J. Oberhumer                   Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
- */
-
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-#undef USE_CONSOLE
-#undef USE_ANSI
-#undef USE_SCREEN
-#undef USE_SCREEN_VCSA
-#undef USE_SCREEN_CURSES
-#undef USE_FRAMES
-
-#if defined(WITH_GUI) && !defined(NO_CONSOLE)
-#  define NO_CONSOLE
-#endif
-
-#if 1 && defined(__linux__)
-#  define USE_SCREEN
-#  define USE_SCREEN_VCSA
-#  if !defined(HAVE_LINUX_KD_H)
-#    undef USE_SCREEN
-#    undef USE_SCREEN_VCSA
-#  endif
-#  if !defined(HAVE_LINUX_KDEV_T_H) || !defined(HAVE_LINUX_MAJOR_H)
-#    undef USE_SCREEN
-#    undef USE_SCREEN_VCSA
-#  endif
-#endif
-
-#if 1 && defined(__DJGPP__)
-#  define USE_SCREEN
-#endif
-
-#if 1 && defined(__MFX_WIN32)
-#  define USE_SCREEN
-#endif
-
-
-#if 0 || defined(NO_ANSI)
-#  undef USE_ANSI
-#endif
-#if 0 || defined(NO_SCREEN)
-#  undef USE_SCREEN
-#endif
-#if 0 || defined(NO_FRAMES) || !defined(USE_SCREEN)
-#  undef USE_FRAMES
-#endif
-#if 1
-#  undef USE_FRAMES
-#endif
-
-
-#if 0 || defined(USE_ANSI) || defined(USE_SCREEN)
-#  define USE_CONSOLE
-#endif
-
-#if 0 || defined(NO_CONSOLE) || !defined(USE_CONSOLE)
-#  undef USE_CONSOLE
-#  undef USE_ANSI
-#  undef USE_SCREEN
-#  undef USE_SCREEN_VCSA
-#  undef USE_SCREEN_CURSES
-#  undef USE_FRAMES
-#endif
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-enum {
-    CON_INIT,
-    CON_NONE,
-    CON_FILE,
-    CON_ANSI_MONO,
-    CON_ANSI_COLOR,
-    CON_SCREEN,
-    CON_UNUSED
-};
-
-
-#if defined(USE_CONSOLE)
-
-typedef struct
-{
-    int (*init)(FILE *f, int, int);
-    int (*set_fg)(FILE *f, int fg);
-    void (*print0)(FILE *f, const char *s);
-    upx_bool (*intro)(FILE *f);
-}
-console_t;
-
-
-#if defined(__GNUC__)
-void con_fprintf(FILE *f, const char *format, ...)
-        __attribute__((format(printf,2,3)));
-#else
-void con_fprintf(FILE *f, const char *format, ...);
-#endif
-
-
-#define FG_BLACK     0x00
-#define FG_BLUE      0x01
-#define FG_GREEN     0x02
-#define FG_CYAN      0x03
-#define FG_RED       0x04
-#define FG_VIOLET    0x05
-#define FG_ORANGE    0x06
-#define FG_LTGRAY    0x07
-#define FG_DKGRAY    0x08
-#define FG_BRTBLUE   0x09
-#define FG_BRTGREEN  0x0a
-#define FG_BRTCYAN   0x0b
-#define FG_BRTRED    0x0c
-#define FG_BRTVIOLET 0x0d
-#define FG_YELLOW    0x0e
-#define FG_WHITE     0x0f
-
-#define BG_BLACK     0x00
-#define BG_BLUE      0x10
-#define BG_GREEN     0x20
-#define BG_CYAN      0x30
-#define BG_RED       0x40
-#define BG_VIOLET    0x50
-#define BG_ORANGE    0x60
-#define BG_WHITE     0x70
-
-#endif /* USE_CONSOLE */
-
-
-/*************************************************************************
-//
-**************************************************************************/
-
-extern FILE *con_term;
-
-#if defined(USE_CONSOLE)
-
-extern int con_mode;
-extern console_t *con;
-
-extern console_t console_init;
-extern console_t console_none;
-extern console_t console_file;
-extern console_t console_ansi_mono;
-extern console_t console_ansi_color;
-extern console_t console_screen;
-
-
-#define con_fg(f,x)     con->set_fg(f,x)
-
-#else
-
-#define con_fg(f,x)     0
-#define con_fprintf     fprintf
-
-#endif /* USE_CONSOLE */
-
-
-/*
-vi:ts=4:et
-*/
-

src/console/c_file.cpp

@@ -1,9 +1,9 @@
-/* c_file.cpp -- file console output
+/* c_file.cpp --
 
    This file is part of the UPX executable compressor.
 
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
    All Rights Reserved.
 
    UPX and the UCL library are free software; you can redistribute them
@@ -22,75 +22,53 @@
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
  */
 
+#include "../conf.h"
 
-#include "conf.h"
-
-#if defined(USE_CONSOLE)
+#if (USE_CONSOLE)
 
 /*************************************************************************
 //
 **************************************************************************/
 
-static int init(FILE *f, int o, int now)
-{
+static int init(FILE *f, int o, int now) {
     UNUSED(f);
     UNUSED(o);
     UNUSED(now);
     return CON_FILE;
 }
 
-
-static int set_fg(FILE *f, int fg)
-{
+static int set_fg(FILE *f, int fg) {
     UNUSED(f);
     UNUSED(fg);
     return -1;
 }
 
-
-static void print0(FILE *f, const char *s)
-{
+static void print0(FILE *f, const char *s) {
 #if 1
-    fputs(s,f);
+    fputs(s, f);
 #else
     /* filter out all ANSI sequences */
     int c;
-    while ((c = *s++) != 0)
-    {
-        if (c == '\033' && *s == ']')
-        {
+    while ((c = *s++) != 0) {
+        if (c == '\033' && *s == ']') {
             while (*s && *s != 'm')
                 s++;
-        }
-        else
-            fputc(c,f);
+        } else
+            fputc(c, f);
     }
 #endif
 }
 
-
-static upx_bool intro(FILE *f)
-{
+static bool intro(FILE *f) {
     UNUSED(f);
     return 0;
 }
 
-
-console_t console_file =
-{
-    init,
-    set_fg,
-    print0,
-    intro
-};
+console_t console_file = {init, set_fg, print0, intro};
 
 #endif /* USE_CONSOLE */
 
-
-/*
-vi:ts=4:et
-*/
-
+/* vim:set ts=4 sw=4 et: */

src/console/c_init.cpp

@@ -1,9 +1,9 @@
-/* c_init.cpp -- console initialization
+/* c_init.cpp --
 
    This file is part of the UPX executable compressor.
 
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
    All Rights Reserved.
 
    UPX and the UCL library are free software; you can redistribute them
@@ -22,33 +22,30 @@
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
  */
 
+#include "../conf.h"
 
-#include "conf.h"
+FILE *con_term = nullptr;
 
-FILE *con_term = NULL;
-
-#if defined(USE_CONSOLE)
+#if (USE_CONSOLE)
 
 /*************************************************************************
 //
 **************************************************************************/
 
-static console_t * const me = &console_init;
-console_t * con = &console_init;
+static console_t *const me = &console_init;
+console_t *con = &console_init;
 
 int con_mode = CON_INIT;
 
-
-static void try_init(console_t *c, FILE *f)
-{
+static void try_init(console_t *c, FILE *f) {
     int k;
 
     assert(c);
     assert(c->init);
-    k = c->init(f,opt->console,con_mode);
+    k = c->init(f, opt->console, con_mode);
     if (k == CON_INIT)
         return;
 #if 0
@@ -56,11 +53,10 @@ static void try_init(console_t *c, FILE *f)
         if (k != opt->console)
             return;
 #endif
-    if (k > con_mode)
-    {
+    if (k > con_mode) {
         con_mode = k;
         con = c;
-        con->init = 0;
+        con->init = nullptr;
         if (!con->set_fg)
             con->set_fg = console_none.set_fg;
         if (!con->print0)
@@ -70,41 +66,37 @@ static void try_init(console_t *c, FILE *f)
     }
 }
 
-
-static int do_init(FILE *f)
-{
+static int do_init(FILE *f) {
     assert(con_mode == CON_INIT);
 
-    try_init(&console_none,f);
+    try_init(&console_none, f);
     assert(con != me);
     assert(con == &console_none);
     if (opt->console == CON_NONE || opt->to_stdout)
         return con_mode;
-    try_init(&console_file,f);
-    if (!isatty(STDIN_FILENO) || !isatty(STDOUT_FILENO) || !isatty(STDERR_FILENO))
+    try_init(&console_file, f);
+    if (!acc_isatty(STDIN_FILENO) || !acc_isatty(STDOUT_FILENO) || !acc_isatty(STDERR_FILENO))
         return con_mode;
 
-#if defined(USE_ANSI)
-    try_init(&console_ansi_mono,f);
-    try_init(&console_ansi_color,f);
+#if (USE_ANSI)
+    try_init(&console_ansi_mono, f);
+    try_init(&console_ansi_color, f);
 #endif
-#if defined(USE_SCREEN)
-    try_init(&console_screen,f);
+#if (USE_SCREEN)
+    try_init(&console_screen, f);
 #endif
-#if defined(USE_AALIB)
-    try_init(&console_aalib,f);
+#if (USE_AALIB)
+    try_init(&console_aalib, f);
 #endif
 
     return con_mode;
 }
 
-
 /*************************************************************************
 //
 **************************************************************************/
 
-static int init(FILE *f, int o, int now)
-{
+static int init(FILE *f, int o, int now) {
     if (con != me)
         return con_mode;
     assert(o == -1);
@@ -114,53 +106,36 @@ static int init(FILE *f, int o, int now)
     return do_init(f);
 }
 
-
-static int set_fg(FILE *f, int fg)
-{
+static int set_fg(FILE *f, int fg) {
     if (con == me)
-        init(f,-1,-1);
+        init(f, -1, -1);
     assert(con != me);
-    return con->set_fg(f,fg);
+    return con->set_fg(f, fg);
 }
 
-
-static upx_bool intro(FILE *f)
-{
+static bool intro(FILE *f) {
     if (con == me)
-        init(f,-1,-1);
+        init(f, -1, -1);
     assert(con != me);
     return con->intro(f);
 }
 
+console_t console_init = {init, set_fg, nullptr, intro};
 
-console_t console_init =
-{
-    init,
-    set_fg,
-    0,
-    intro
-};
-
-
-void con_fprintf(FILE *f, const char *format, ...)
-{
+void con_fprintf(FILE *f, const char *format, ...) {
     va_list args;
-    char buf[80*25];
+    char buf[80 * 25];
 
-    va_start(args,format);
-    upx_vsnprintf(buf,sizeof(buf),format,args);
+    va_start(args, format);
+    upx_safe_vsnprintf(buf, sizeof(buf), format, args);
     va_end(args);
 
     if (con == me)
-        init(f,-1,-1);
+        init(f, -1, -1);
     assert(con != me);
-    con->print0(f,buf);
+    con->print0(f, buf);
 }
 
 #endif /* USE_CONSOLE */
 
-
-/*
-vi:ts=4:et
-*/
-
+/* vim:set ts=4 sw=4 et: */

src/console/c_none.cpp

@@ -1,9 +1,9 @@
-/* c_none.cpp -- dummy console output
+/* c_none.cpp --
 
    This file is part of the UPX executable compressor.
 
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
    All Rights Reserved.
 
    UPX and the UCL library are free software; you can redistribute them
@@ -22,61 +22,42 @@
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
  */
 
+#include "../conf.h"
 
-#include "conf.h"
-
-#if defined(USE_CONSOLE)
+#if (USE_CONSOLE)
 
 /*************************************************************************
 //
 **************************************************************************/
 
-static int init(FILE *f, int o, int now)
-{
+static int init(FILE *f, int o, int now) {
     UNUSED(f);
     UNUSED(o);
     UNUSED(now);
     return CON_NONE;
 }
 
-
-static int set_fg(FILE *f, int fg)
-{
+static int set_fg(FILE *f, int fg) {
     UNUSED(f);
     UNUSED(fg);
     return -1;
 }
 
-
-static void print0(FILE *f, const char *s)
-{
+static void print0(FILE *f, const char *s) {
     UNUSED(f);
     UNUSED(s);
 }
 
-
-static upx_bool intro(FILE *f)
-{
+static bool intro(FILE *f) {
     UNUSED(f);
     return 0;
 }
 
-
-console_t console_none =
-{
-    init,
-    set_fg,
-    print0,
-    intro
-};
+console_t console_none = {init, set_fg, print0, intro};
 
 #endif /* USE_CONSOLE */
 
-
-/*
-vi:ts=4:et
-*/
-
+/* vim:set ts=4 sw=4 et: */

src/console/c_screen.cpp

@@ -2,8 +2,8 @@
 
    This file is part of the UPX executable compressor.
 
-   Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
-   Copyright (C) 1996-2000 Laszlo Molnar
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
    All Rights Reserved.
 
    UPX and the UCL library are free software; you can redistribute them
@@ -22,29 +22,26 @@
    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
    Markus F.X.J. Oberhumer              Laszlo Molnar
-   markus.oberhumer@jk.uni-linz.ac.at        ml1050@cdata.tvnet.hu
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
  */
 
+#include "../conf.h"
 
-#include "conf.h"
-
-#if defined(USE_SCREEN)
+#if (USE_SCREEN)
 
 #include "screen.h"
 
 #define mask_fg 0x0f
 #define mask_bg 0xf0
 
-
 /*************************************************************************
 //
 **************************************************************************/
 
-static int do_init(screen_t *s, int fd)
-{
+static int do_init(screen_t *s, int fd) {
     int fg, bg;
 
-    if (s->init(s,fd) != 0)
+    if (s->init(s, fd) != 0)
         return -1;
 
     if (s->getCols(s) < 80 || s->getCols(s) > 256)
@@ -59,8 +56,7 @@ static int do_init(screen_t *s, int fd)
     if (fg == (bg >> 4))
         return -1;
     if (bg != BG_BLACK)
-        if (!s->isMono(s))
-        {
+        if (!s->isMono(s)) {
             /* return 0; */ /* we could emulate ANSI mono */
             return -1;
         }
@@ -68,52 +64,43 @@ static int do_init(screen_t *s, int fd)
     return 0;
 }
 
-
-static screen_t *do_construct(screen_t *s, int fd)
-{
+static screen_t *do_construct(screen_t *s, int fd) {
     if (!s)
-        return NULL;
-    if (do_init(s,fd) != 0)
-    {
+        return nullptr;
+    if (do_init(s, fd) != 0) {
         s->destroy(s);
-        return NULL;
+        return nullptr;
     }
     return s;
 }
 
-
 /*************************************************************************
 //
 **************************************************************************/
 
-static screen_t *screen = NULL;
+static screen_t *screen = nullptr;
 
-static void do_destroy(void)
-{
-    if (screen)
-    {
+static void __acc_cdecl_atexit do_destroy(void) {
+    if (screen) {
         if (screen->atExit)
             screen->atExit();
         screen->destroy(screen);
-        screen = NULL;
+        screen = nullptr;
     }
 }
 
-
 static int mode = -1;
 static int init_fg = -1;
 static int init_bg = -1;
 static int cur_fg = -1;
 static int cur_bg = -1;
 
-
-static int init(FILE *f, int o, int now)
-{
+static int init(FILE *f, int o, int now) {
     int fd = fileno(f);
     int n;
 
     UNUSED(now);
-    assert(screen == NULL);
+    assert(screen == nullptr);
 
     if (o == CON_SCREEN)
         n = CON_SCREEN;
@@ -126,21 +113,21 @@ static int init(FILE *f, int o, int now)
     else
         return CON_INIT;
 
-#if defined(__DJGPP__)
+#if (ACC_OS_DOS32) && defined(__DJGPP__)
     if (!screen)
-        screen = do_construct(screen_djgpp2_construct(),fd);
+        screen = do_construct(screen_djgpp2_construct(), fd);
 #endif
-#if defined(__MFX_WIN32)
+#if (USE_SCREEN_WIN32)
     if (!screen)
-        screen = do_construct(screen_win32_construct(),fd);
+        screen = do_construct(screen_win32_construct(), fd);
 #endif
-#if defined(USE_SCREEN_VCSA)
+#if (USE_SCREEN_VCSA)
     if (!screen)
-        screen = do_construct(screen_vcsa_construct(),fd);
+        screen = do_construct(screen_vcsa_construct(), fd);
 #endif
-#if defined(USE_SCREEN_CURSES)
+#if (USE_SCREEN_CURSES)
     if (!screen && o == CON_SCREEN)
-        screen = do_construct(screen_curses_construct(),fd);
+        screen = do_construct(screen_curses_construct(), fd);
 #endif
     if (!screen)
         return CON_INIT;
@@ -155,17 +142,14 @@ static int init(FILE *f, int o, int now)
     return n;
 }
 
-
-static int set_fg(FILE *f, int fg)
-{
+static int set_fg(FILE *f, int fg) {
     const int last_fg = cur_fg;
     int f1 = fg & mask_fg;
     int f2 = init_fg & mask_fg;
 
     UNUSED(f);
     cur_fg = fg;
-    if (screen->isMono(screen))
-    {
+    if (screen->isMono(screen)) {
         const int b = (init_bg & mask_bg) >> 4;
         if (fg == -1) /* restore startup fg */
             f1 = f2;
@@ -175,19 +159,15 @@ static int set_fg(FILE *f, int fg)
             f1 = (f2 == 0) ? 15 : 0;
         else
             f1 = (f2 == 0) ? 8 : 0;
-    }
-    else if (con_mode == CON_ANSI_MONO && f1 != f2)
-    {
+    } else if (con_mode == CON_ANSI_MONO && f1 != f2) {
         f1 = f2 ^ 0x08;
     }
 
-    screen->setFg(screen,f1 & mask_fg);
+    screen->setFg(screen, f1 & mask_fg);
     return last_fg;
 }
 
-
-static void print0(FILE *f, const char *ss)
-{
+static void print0(FILE *f, const char *ss) {
     int cx, cy;
     int old_cx = 0, old_cy = 0;
     const int sx = screen->getCols(screen);
@@ -196,60 +176,50 @@ static void print0(FILE *f, const char *ss)
 
     // Note:
     //   We use 2 passes to avoid unnecessary system calls because
-    //   scrollUp() under Win95/98 is *extremely* slow.
+    //   scrollUp() under Win32 is *extremely* slow.
     UNUSED(f);
 
-    screen->getCursor(screen,&old_cx,&old_cy);
-    cx = old_cx; cy = old_cy;
+    screen->getCursor(screen, &old_cx, &old_cy);
+    cx = old_cx;
+    cy = old_cy;
 
-    for (pass = 0; pass < 2; pass++)
-    {
+    for (pass = 0; pass < 2; pass++) {
         const char *s = ss;
         // char buffer for pass 2
-        char p[256+1];
+        char p[256 + 1];
         int pi = 0, px = 0, py = 0;
 
-        for (;;)
-        {
+        for (;;) {
             // walk over whitespace
-            for (;;)
-            {
-                if (*s == '\n')
-                {
+            for (;;) {
+                if (*s == '\n') {
                     cx = 0;
                     cy++;
-                }
-                else if (*s == '\r')
-                {
+                } else if (*s == '\r') {
                     cx = 0;
                     if (pass > 0 && cy < sy)
-                        screen->clearLine(screen,cy);
-                }
-                else
+                        screen->clearLine(screen, cy);
+                } else
                     break;
                 s++;
             }
             // adjust cursor
-            if (cx >= sx)
-            {
+            if (cx >= sx) {
                 cx = 0;
                 cy++;
             }
-            if (pass > 0)
-            {
+            if (pass > 0) {
                 // check if we should print something
-                if (pi > 0 && (*s == 0 || py != cy))
-                {
+                if (pi > 0 && (*s == 0 || py != cy)) {
                     p[pi] = 0;
-                    screen->putString(screen,p,px,py);
+                    screen->putString(screen, p, px, py);
                     pi = 0;
                 }
                 // check if we should scroll even more (this can happen
                 // if the string is longer than sy lines)
-                if (cy >= sy)
-                {
+                if (cy >= sy) {
                     int scroll_y = cy - sy + 1;
-                    screen->scrollUp(screen,scroll_y);
+                    screen->scrollUp(screen, scroll_y);
                     cy -= scroll_y;
                     if (cy < 0)
                         cy = 0;
@@ -258,11 +228,9 @@ static void print0(FILE *f, const char *ss)
             // done ?
             if (*s == 0)
                 break;
-            if (pass > 0)
-            {
+            if (pass > 0) {
                 // store current char
-                if (pi == 0)
-                {
+                if (pi == 0) {
                     px = cx;
                     py = cy;
                 }
@@ -273,52 +241,35 @@ static void print0(FILE *f, const char *ss)
             s++;
         }
 
-        if (pass == 0)
-        {
+        if (pass == 0) {
             // end of pass 1 - scroll up, restore cursor
-            if (cy >= sy)
-            {
+            if (cy >= sy) {
                 int scroll_y = cy - sy + 1;
-                screen->scrollUp(screen,scroll_y);
+                screen->scrollUp(screen, scroll_y);
                 cy = old_cy - scroll_y;
                 if (cy < 0)
                     cy = 0;
-            }
-            else
+            } else
                 cy = old_cy;
             cx = old_cx;
         }
     }
 
-    screen->setCursor(screen,cx,cy);
+    screen->setCursor(screen, cx, cy);
     screen->refresh(screen);
 }
 
-
-static upx_bool intro(FILE *f)
-{
+static bool intro(FILE *f) {
     UNUSED(f);
-#if defined(USE_FRAMES)
+#if (USE_FRAMES)
     if (screen->intro)
-        return screen->intro(screen,screen_show_frames);
+        return screen->intro(screen, screen_show_frames);
 #endif
     return 0;
 }
 
-
-console_t console_screen =
-{
-    init,
-    set_fg,
-    print0,
-    intro
-};
-
+console_t console_screen = {init, set_fg, print0, intro};
 
 #endif /* USE_SCREEN */
 
-
-/*
-vi:ts=4:et
-*/
-
+/* vim:set ts=4 sw=4 et: */

src/console/console.h

@@ -0,0 +1,169 @@
+/* console.h --
+
+   This file is part of the UPX executable compressor.
+
+   Copyright (C) 1996-2023 Markus Franz Xaver Johannes Oberhumer
+   Copyright (C) 1996-2023 Laszlo Molnar
+   All Rights Reserved.
+
+   UPX and the UCL library are free software; you can redistribute them
+   and/or modify them under the terms of the GNU General Public License as
+   published by the Free Software Foundation; either version 2 of
+   the License, or (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; see the file COPYING.
+   If not, write to the Free Software Foundation, Inc.,
+   59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+   Markus F.X.J. Oberhumer              Laszlo Molnar
+   <markus@oberhumer.com>               <ezerotven+github@gmail.com>
+ */
+
+#pragma once
+
+/*************************************************************************
+//
+**************************************************************************/
+
+#undef USE_CONSOLE
+#undef USE_ANSI
+#undef USE_SCREEN
+#undef USE_SCREEN_CURSES
+#undef USE_SCREEN_VCSA
+#undef USE_SCREEN_WIN32
+#undef USE_FRAMES
+
+#if 1 && (WITH_GUI) && !defined(NO_CONSOLE)
+#define NO_CONSOLE 1
+#endif
+
+#if 1 && defined(__linux__)
+#define USE_SCREEN 1
+#define USE_SCREEN_VCSA 1
+#if !(HAVE_LINUX_KD_H)
+#undef USE_SCREEN
+#undef USE_SCREEN_VCSA
+#endif
+#if !(HAVE_LINUX_KDEV_T_H) || !(HAVE_LINUX_MAJOR_H)
+#undef USE_SCREEN
+#undef USE_SCREEN_VCSA
+#endif
+#endif
+
+#if 1 && (ACC_OS_DOS32) && defined(__DJGPP__)
+#define USE_SCREEN 1
+#elif 1 && (ACC_OS_CYGWIN || ACC_OS_WIN32 || ACC_OS_WIN64)
+#define USE_SCREEN 1
+#define USE_SCREEN_WIN32 1
+#elif 1 && (ACC_OS_EMX && defined(__RSXNT__))
+#define USE_SCREEN 1
+#define USE_SCREEN_WIN32 1
+#elif 1 && (ACC_ARCH_M68K && ACC_OS_TOS)
+#define NO_CONSOLE 1
+#endif
+
+#if 0 || (NO_ANSI)
+#undef USE_ANSI
+#endif
+#if 0 || (NO_SCREEN)
+#undef USE_SCREEN
+#endif
+#if 0 || (NO_FRAMES) || !(USE_SCREEN)
+#undef USE_FRAMES
+#endif
+#if 1
+#undef USE_FRAMES
+#endif
+
+#if 0 || (USE_ANSI) || (USE_SCREEN)
+#define USE_CONSOLE 1
+#endif
+
+#if 0 || (NO_CONSOLE) || !(USE_CONSOLE)
+#undef USE_CONSOLE
+#undef USE_ANSI
+#undef USE_SCREEN
+#undef USE_SCREEN_VCSA
+#undef USE_SCREEN_CURSES
+#undef USE_FRAMES
+#endif
+
+/*************************************************************************
+//
+**************************************************************************/
+
+enum { CON_INIT, CON_NONE, CON_FILE, CON_ANSI_MONO, CON_ANSI_COLOR, CON_SCREEN, CON_UNUSED };
+
+#if (USE_CONSOLE)
+
+typedef struct {
+    int (*init)(FILE *f, int, int);
+    int (*set_fg)(FILE *f, int fg);
+    void (*print0)(FILE *f, const char *s);
+    bool (*intro)(FILE *f);
+} console_t;
+
+void con_fprintf(FILE *f, const char *format, ...) attribute_format(2, 3);
+
+#define FG_BLACK 0x00
+#define FG_BLUE 0x01
+#define FG_GREEN 0x02
+#define FG_CYAN 0x03
+#define FG_RED 0x04
+#define FG_VIOLET 0x05
+#define FG_ORANGE 0x06
+#define FG_LTGRAY 0x07
+#define FG_DKGRAY 0x08
+#define FG_BRTBLUE 0x09
+#define FG_BRTGREEN 0x0a
+#define FG_BRTCYAN 0x0b
+#define FG_BRTRED 0x0c
+#define FG_BRTVIOLET 0x0d
+#define FG_YELLOW 0x0e
+#define FG_WHITE 0x0f
+
+#define BG_BLACK 0x00
+#define BG_BLUE 0x10
+#define BG_GREEN 0x20
+#define BG_CYAN 0x30
+#define BG_RED 0x40
+#define BG_VIOLET 0x50
+#define BG_ORANGE 0x60
+#define BG_WHITE 0x70
+
+#endif /* USE_CONSOLE */
+
+/*************************************************************************
+//
+**************************************************************************/
+
+extern FILE *con_term;
+
+#if (USE_CONSOLE)
+
+extern int con_mode;
+extern console_t *con;
+
+extern console_t console_init;
+extern console_t console_none;
+extern console_t console_file;
+extern console_t console_ansi_mono;
+extern console_t console_ansi_color;
+extern console_t console_screen;
+
+#define con_fg(f, x) con->set_fg(f, x)
+
+#else
+
+#define con_fg(f, x) 0
+#define con_fprintf fprintf
+
+#endif /* USE_CONSOLE */
+
+/* vim:set ts=4 sw=4 et: */