Expected PDB name is incorrect and disagrees with docs

[asgrim]

The maintainer docs state:

• php_{extension-name}.pdb - this will be moved alongside
  the C:\path\to\php\ext\php_{extension-name}.dll

This implies the PDB name should be something like php_xdebug.pdb; however, PIE is incorrectly expecting the PDB name to be aligned with the DLL:

pie/src/Installing/WindowsInstall.php

Line 39 in eaf77ea

$sourcePdbName = str_replace('.dll', '.pdb', $sourceDllName);

( related discussion: mongodb/mongo-php-driver#1732 (comment) )

[derickr]

I don't think I make pdbs for Xdebug though? I do need to so that actually... But don't know how. Does @shivammathur 's new GitHub action support it?

[shivammathur]

Yes, php-windows-builder builds the extension with the pdb file, but it follows the naming scheme for both the dll and the pdb file.

[asgrim]

Yes, php-windows-builder builds the extension with the pdb file, but it follows the naming scheme for both the dll and the pdb file.

Ah - just to clarify, do you mean the naming should be:

• php_{extension-name}-{tag}-{php-maj/min}-{ts|nts}-{compiler}-{arch}.zip containing:
  • php_{extension-name}-{tag}-{php-maj/min}-{ts|nts}-{compiler}-{arch}.dll
  • Optionally php_{extension-name}-{tag}-{php-maj/min}-{ts|nts}-{compiler}-{arch}.pdb
  • (any other files)

If so that is what is implemented in PIE, and the PIE docs are wrong and need updating :)

The docs we'd originally written imply it should've been:

• php_{extension-name}-{tag}-{php-maj/min}-{ts|nts}-{compiler}-{arch}.zip containing:
  • php_{extension-name}-{tag}-{php-maj/min}-{ts|nts}-{compiler}-{arch}.dll
  • Optionally php_{extension-name}.pdb <-- no additional information
  • (any other files)

I don't have a personal preference, I just want to ensure all the tooling is aligned :)

[shivammathur]

The DLL file and the PDB files for the extension should have the same name for the following reasons.

• As a convention the PDB file with the same name as the DLL is the symbol file for it in the package, as that is how they are generated.
• There might be other DLL and PDB files from the dependencies and cause confusion if the names do not match.

So, I think we should change the docs for this that both files will follow the naming scheme we decided. On installation pie will rename them to php_<extension>.dll and php_<extension>.pdb and place them in the ext directory.

[asgrim]

Thanks for clarifying. I will update the docs accordingly

[cmb69]

Note that you cannot arbitrarily rename PDB files. The path of the PDB is stored in the executable (DLL or EXE), and looked up automatically when debugging. To my knowledge, there is no problem to put the executable and its PDB in another folder. It is even possible to put the PDBs in a different folder than the executables and tell the debugger in which folder to search for PDBs (inconvenient, though). However, you must not change the basename.

[asgrim]

Note that you cannot arbitrarily rename PDB files. The path of the PDB is stored in the executable (DLL or EXE), and looked up automatically when debugging. ... However, you must not change the basename.

Yep, that is my understanding too; the PDB is placed alongside the DLL, and is named in the same way (e.g. php_xdebug.dll and php_xdebug.pdb in the same directory).

[cmb69]

Yeah, but that works only if the DLL was build that way. If some one builds e.g. php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.dll with php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.pdb, you can rename php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.dll to php_xdebug.dll, but not php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.pdb to php_xdebug.pdb. And if they build php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.dll with php_xdebug.pdb, but ship php_xdebug-3.4.0beta1-8.3-nts-vs16-x64.pdb that won't work either (in case someone downloads and installs manually).

[asgrim]

Hmm; @shivammathur how are these built? 🤔 @cmb69 seems to have a point (although I haven't checked it out myself yet)

[shivammathur]

They are built as php_xdebug.dll and php_xdebug.pdb and then while packaging for pie, they are renamed as per the naming scheme, and thus the need for renaming them back during the install.

I agree with the issue when someone manually downloads the builds and does not use pie.