Preserve BASS FX and BASSmix library symbols from getting stripped in iOS #4890
Conversation
osu.Framework.iOS.props
Outdated
| And therefore mtouch would consider the libraries symbols as unused and strip them away. | ||
|
|
||
| In order to work around it, specify each symbol of each library with the "nosymbolstrip={symbol}" flag to preserve it from getting stripped. | ||
| Use the following script to generate the "nosymbolstrip" flags: https://gist.github.com/frenzibyte/a09112e31cb28bc8becfa76d6a2bd23a --> |
There was a problem hiding this comment.
this script should not be in a random gist, it should be in this repository.
extra points if you can make it update this props file automatically in the correct manner.
There was a problem hiding this comment.
Well there exists a linked gist in the framework already, but sure can turn it to a framework wiki page if that's fine?
As for updating the props file automatically, sounds feasible, will look at it.
There was a problem hiding this comment.
not a wiki page. an executable script in source. that you can run without copying it over from wiki or a gist or wherever.
There was a problem hiding this comment.
Ah I see, will look at that.
There was a problem hiding this comment.
Added script in source with automatic project updating support. But the generated symbols will still have to be copied across to osu! and templates, unfortunately. As they can't access the native libraries to extract the symbols from, unless it's fine to attempt finding the osu-framework folder, which I'm not really sure about doing.
I'm planning on reporting the original issue to Xamarin anyways, as I'm hoping we wouldn't require this long term.
There was a problem hiding this comment.
I'm planning on reporting the original issue to Xamarin anyways, as I'm hoping we wouldn't require this long term.
About that (check upstream report). Safe to say this workaround is sticking with us until NET6.
|
Needs conflict resolution. |
|
I can't verify the script because linux (Albeit I will say that a few things look weird - why no |
Just to clarify things out, I'm not really competent with sh/bash scripting, but felt this is enough to be correct (or so have I thought). Regarding the As for the |
|
Reported upstream at xamarin/xamarin-macios#13359. |
mtouchdoesn't considerdllmaps when stripping native library symbols during build xamarin/xamarin-macios#13359.Normally, any native library wrapper class under iOS would have to import from
__Internalin order to p/invoke the methods successfully.But
ManagedBassplayed it differently on the BASS addons (BASS FX, BASSmix, etc.) starting from 3.0.0, by importing from the native library name as-is, but instead usingdllmaps to map the native library names to__Internalto be able to p/invoke on iOS (see ManagedBass/ManagedBass#30).And that appears to be working (minus one worked around issue), but not quite with mtouch's strip symbols feature... (which is enabled on Release configuration)
It appears that mtouch isn't aware of the
dllmapconfiguration and thinks that the BASS FX and BASSmix symbols aren't used anywhere (while they're, but imported frombass_fx/bassmixwithdllmaprather than__Internaldirectly), and therefore strips the symbols out and causingEntryPointNotFoundEexceptionwhen attempting to call any of the library methods.The only workaround to this as far as I've seen from trying out several other ways is to tell mtouch to specifically preserve each symbol of the library, and I've done that via this quick script I've wrote, which takes defined and external symbols from the library, and prepend the
--nosymbolstrip=flag to each.Other ways like using the
Preserveattribute againstManagedBass.Fx.BassFxcan't work, becauseBassFximports the methods frombass_fx, while mtouch would be looking for imports from__Internalto actually preserve the symbols.