undefined symbol: _OBJC_CLASS_$_SPUStandardUpdaterController

[dewren99]

Description of the problem

I have been building the source codes for the Vivaldi browser, however ever since Vivaldi switched to using Sparkle 2.1 (Vivaldi 5.2+) I've been getting the following error (on both x86 and arm64) during the linking stage:

[1/46] SOLINK libchrome_dll.dylib libchrome_dll.dylib.TOC
FAILED: libchrome_dll.dylib libchrome_dll.dylib.TOC 
if [ ! -e "./libchrome_dll.dylib" -o ! -e "./libchrome_dll.dylib.TOC" ] || /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/otool -l "./libchrome_dll.dylib" | grep -q LC_REEXPORT_DYLIB ; then TOOL_VERSION=1656955941 ../../chromium/build/toolchain/apple/linker_driver.py -Wcrl,strippath,/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/strip ../../chromium/third_party/llvm-build/Release+Asserts/bin/clang++ -shared  -Wl,-install_name,@rpath/"libchrome_dll.dylib" -Wl,-order_file -Wl,../../chromium/chrome/app/framework.order -ObjC -fuse-ld=lld -Wl,-fatal_warnings -Wl,--icf=all -Wl,--color-diagnostics -arch arm64 -no-canonical-prefixes -Werror -Wl,-dead_strip -nostdlib++ -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk -mmacosx-version-min=10.11.0 -Wl,-ObjC -Wl,-rpath,@loader_path/. -Wl,-rpath,@loader_path/../../.. -L/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk/usr/lib -o "./libchrome_dll.dylib" "@./libchrome_dll.dylib.rsp" && { /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/otool -l "./libchrome_dll.dylib" | grep LC_ID_DYLIB -A 5; /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/nm -gPp "./libchrome_dll.dylib" | cut -f1-2 -d' ' | grep -v U$$; true; } > "./libchrome_dll.dylib.TOC"; else TOOL_VERSION=1656955941 ../../chromium/build/toolchain/apple/linker_driver.py -Wcrl,strippath,/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/strip ../../chromium/third_party/llvm-build/Release+Asserts/bin/clang++ -shared  -Wl,-install_name,@rpath/"libchrome_dll.dylib" -Wl,-order_file -Wl,../../chromium/chrome/app/framework.order -ObjC -fuse-ld=lld -Wl,-fatal_warnings -Wl,--icf=all -Wl,--color-diagnostics -arch arm64 -no-canonical-prefixes -Werror -Wl,-dead_strip -nostdlib++ -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk -mmacosx-version-min=10.11.0 -Wl,-ObjC -Wl,-rpath,@loader_path/. -Wl,-rpath,@loader_path/../../.. -L/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk/usr/lib -o "./libchrome_dll.dylib" "@./libchrome_dll.dylib.rsp" && { /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/otool -l "./libchrome_dll.dylib" | grep LC_ID_DYLIB -A 5; /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/nm -gPp "./libchrome_dll.dylib" | cut -f1-2 -d' ' | grep -v U$$; true; } > "./libchrome_dll.dylib.tmp" && if ! cmp -s "./libchrome_dll.dylib.tmp" "./libchrome_dll.dylib.TOC"; then mv "./libchrome_dll.dylib.tmp" "./libchrome_dll.dylib.TOC" ; fi; fi
ld64.lld: error: undefined symbol: _OBJC_CLASS_$_SPUStandardUpdaterController
>>> referenced by obj/chrome/browser/libbrowser.a(app_controller_mac.o)
clang++: error: linker command failed with exit code 1 (use -v to see invocation)
Traceback (most recent call last):
  File "../../chromium/build/toolchain/apple/linker_driver.py", line 341, in <module>
    LinkerDriver(sys.argv).run()
  File "../../chromium/build/toolchain/apple/linker_driver.py", line 117, in run
    subprocess.check_call(compiler_driver_args, env=env)
  File "/Applications/Xcode.app/Contents/Developer/Library/Frameworks/Python3.framework/Versions/3.8/lib/python3.8/subprocess.py", line 364, in check_call
    raise CalledProcessError(retcode, cmd)
subprocess.CalledProcessError: Command '['../../chromium/third_party/llvm-build/Release+Asserts/bin/clang++', '-shared', '-Wl,-install_name,@rpath/libchrome_dll.dylib', '-Wl,-order_file', '-Wl,../../chromium/chrome/app/framework.order', '-ObjC', '-fuse-ld=lld', '-Wl,-fatal_warnings', '-Wl,--icf=all', '-Wl,--color-diagnostics', '-arch', 'arm64', '-no-canonical-prefixes', '-Werror', '-Wl,-dead_strip', '-nostdlib++', '-isysroot', '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk', '-mmacosx-version-min=10.11.0', '-Wl,-ObjC', '-Wl,-rpath,@loader_path/.', '-Wl,-rpath,@loader_path/../../..', '-L/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.3.sdk/usr/lib', '-o', './libchrome_dll.dylib', '@./libchrome_dll.dylib.rsp']' returned non-zero exit status 1.
ninja: build stopped: subcommand failed.

I was able to narrow the issue down to the following code block:

SPUStandardUpdaterController* _sparkle_updater_controller;
...
...
if (...) {
  _sparkle_updater_delegate = [[SparkleUpdaterDelegate alloc] init];
  _sparkle_updater_controller = [[SPUStandardUpdaterController alloc]
      initWithUpdaterDelegate: _sparkle_updater_delegate
      userDriverDelegate: nil];
}
...

Although SPUStandardUpdaterController is used multiple times in the code, the error only occurs when [SPUStandardUpdaterController alloc] is called.

Obviously, the issue is related to how Vivaldi integrates Sparkle rather than the Sparkle itself, but I was wondering if there is an obvious mistake the way SPUStandardUpdaterController is being allocated here causing the error.

Do you use Sandboxing in your app?

N/A

Version of Sparkle.framework in the latest version of your app

2.1.0

Version of Sparkle.framework in the old version of app that your users have (or N/A)

N/A

Sparkle's output from Console.app

[zorgiepoo]

This is a linker compiling issue. You may not be linking against Sparkle correctly. The only thing Sparkle 2 might be changing from 1.x in this regard is it uses Versions/B/ rather than Versions/A/ in the framework.. but normally you don't reference a specific version.

Although SPUStandardUpdaterController is used multiple times in the code, the error only occurs when [SPUStandardUpdaterController alloc] is called.

It's not used multiple times in this snippet. The only time it's used is when messaging alloc in your snippet. Declaring a variable of type SPUStandardUpdaterController* is not really using it.

I would check the linker flags you are passing and verify that Sparkle is indeed specified there. As the clang++ error says, you can pass -v to see the full invocation that was used.

[BasavarajaPS]

I am also facing the same issue

ld64.lld: error: undefined symbol: OBJC_CLASS_$_SPUStandardUpdaterController

referenced by /Users/basavaraja.sidda/Desktop/workspace/chromium/src/out/release/../../chrome/browser/app_controller_mac.mm

Tried to include the Sparkle.frameowrk in my chromium product version,
lout/release/Chromium.app/Contents/Frameworks/Sparkle.framework/
Autoupdate Modules/ Resources/ Sparkle Updater.app/

I could see framework is part of the build but still the above linker error persists

Please let me know if I'm missing something ?

[zorgiepoo]

See my above reply.

[intouchabhishek]

Hi zorgiepoo

getting error while executing below python script in chromium source

project_name = "Sparkle.xcodeproj"
build_command = "xcodebuild -project " + project_folder + "/" + project_name +
" -scheme Distribution -configuration Release -derivedDataPath " + output_folder +
" -destination platform=macOS" +
" build CODE_SIGN_IDENTITY="" CODE_SIGNING_ALLOWED=NO"
subprocess.call(build_command,cwd=project_folder,shell=True)

the stack trace for the error is mentioned below, unable to figure out why this error is coming

a ./Sparkle.framework/Versions/B/Updater.app/Contents/Info.plist
a ./sparkle.app/Contents/Frameworks/Sparkle.framework/Versions/B/Updater.app/Contents/Info.plist
a ./Sparkle Test App.app/Contents/Frameworks/Sparkle.framework/Versions/B/Updater.app/Contents/Info.plist
/tmp/sparkle-extract/sparkle.app/Contents/Frameworks/Sparkle.framework: code object is not signed at all
/tmp/sparkle-extract/Sparkle Test App.app/Contents/Frameworks/Sparkle.framework: code object is not signed at all
/tmp/sparkle-extract/Sparkle.framework: code object is not signed at all
/tmp/sparkle-extract/sparkle.app: code object is not signed at all
Command ExternalBuildToolExecution failed with a nonzero exit code

warning: Run script build phase 'Run Script: Set Git Version Info' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'Sparkle' from project 'Sparkle')
warning: Run script build phase 'Run Script: Link Tools' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'Sparkle' from project 'Sparkle')
warning: Run script build phase 'Strip Framework' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'Sparkle' from project 'Sparkle')
warning: Run script build phase 'Run Script' will be run during every build because it does not specify any outputs. To address this warning, either add output dependencies to the script phase, or configure it to run in every build by unchecking "Based on dependency analysis" in the script phase. (in target 'XCFrameworks' from project 'Sparkle')
** BUILD FAILED **

The following build commands failed:
ExternalBuildToolExecution Distribution (in target 'Distribution' from project 'Sparkle')
(1 failure)
[11/11] STAMP obj/chrome/dependencies.stamp

Any help in this regard will be much appreciated

[zorgiepoo]

Building without code signing identity (CODE_SIGN_IDENTITY="" CODE_SIGNING_ALLOWED=NO" ) is incorrect. Every binary should be signed with at least an ad-hoc signed signature (-) at minimum. This is required on arm64 anyway.

[intouchabhishek]

Hi zorgiepoo

After doing bundle data I am able to see Sparkle.Framework inside Contents/Frameworks but still I am getting below error when I am trying to use sparkle header files inside code

In file included from ../../chrome/browser/ui/webui/version/version_ui.cc:20:
../../chrome/browser/browser_process_impl.h:38:9: fatal error: 'Sparkle/Sparkle.h' file not found
38 | #import <Sparkle/Sparkle.h>
| ^~~~~~~~~~~~~~~~~~~
1 error generated.
[2/53] OBJCXX obj/chrome/browser/ui/ui/first_run_dialog_cocoa.o

Attached screenshot for reference:

[zorgiepoo]

https://sparkle-project.org/documentation/programmatic-setup/#create-an-updater-in-qt

Link against your copy of Sparkle (-framework Sparkle)
Set the framework search path to the parent directory that contains Sparkle.framework (-F/path/to/dir/)

This is before you copy Sparkle.framework into your app bundle and when you're compiling your app.

Your compiler doesn't know where to find Sparkle headers currently.