vladof81
vladof81

Reputation: 26499

iOS app with framework crashed on device, dyld: Library not loaded, Xcode 6 Beta

This crash has been a blocking issue I used the following steps to reproduce the issue:

The app immediate crashed upon launching, here is console log:

dyld: Library not loaded: @rpath/FrameworkTest03.framework/FrameworkTest03
  Referenced from: /var/mobile/Applications/FA6BAAC8-1AAD-49B4-8326-F30F66458CB6/FrameworkTest03App.app/FrameworkTest03App
  Reason: image not found

I have tried to build on iOS 7.1 and 8.0 devices, they both have the same crash. However, I can build an app and run on the simulator fine. Also, I am aware that I can change the framework to form Required to Optional in Link Binary With Libraries, but it did not completely resolve the problem, the app crashed when I create an instance of Dog. The behavior is different on the device and simulator, I suspect that we can't distribute a framework for the device using a beta version of Xcode. Can anyone shed light on this?

Upvotes: 674

Views: 372469

Answers (30)

yoAlex5
yoAlex5

Reputation: 34341

dyld: Library not loaded: @rpath/<some_path>

It is a runtime error that is caused by Dynamic Linker

dyld: Library not loaded: @rpath/<some_path>
Referenced from: <some_path>
Reason: image not found

The error Library not loaded with @rpath indicates that Dynamic Linker cannot find the binary.

  1. Check if the dynamic framework was added to the front target General -> Frameworks, Libraries, and Embedded Content (Embedded Binaries). It is very simple to drag-and-drop a framework to project with Copy items if needed[About] and miss to add the framework as implicit dependency in
    Frameworks, Libraries, and Embedded Content(or check in Add to targets). In this case during compile time Xcode build it as success but when you run it you get runtime error

  2. Check the @rpath setup between consumer(application) and producer(dynamic framework):

  • Dynamic framework:
    • Build Settings -> Dynamic Library Install Name(LD_DYLIB_INSTALL_NAME). Default is $(DYLIB_INSTALL_NAME_BASE:standardizepath)/$(EXECUTABLE_PATH)
  • Application:
    • Build Settings -> Runpath Search Paths(LD_RUNPATH_SEARCH_PATHS). Default are @executable_path/Frameworks, $(inherited)
    • Build Phases -> Embed Frameworks -> Destination, Subpath
  1. Framework's Mach-O file[About] - Dynamic Library and Application's Frameworks, Libraries, and Embedded Content[About] - Do Not Embed.

Dynamic linker

Dynamic Library Install Name(LD_DYLIB_INSTALL_NAME) which is used by loadable bundle(Dynamic framework as a derivative) where dyld come into play
Dynamic Library Install Name - path to binary file(not .framework). Yes, they have the same name, but MyFramework.framework is a packaged bundle with MyFramework binary file and resources inside.
This path to directory can be absolute or relative(e.g. @executable_path, @loader_path, @rpath). Relative path is more preferable because it is changed together with an anchor that is useful when you distribute your bundle as a single directory

absolute path - Framework1 example

//Framework1 Dynamic Library Install Name
/some_path/Framework1.framework/subfolder1

Relative path allows you to define a path in a dynamic way.

@executable_path

@executable_path - relative to executable binary which loads framework
use case: Dynamic framework inside Application(application binary path is @executable_path) or more complex example with App Extension[About] which is a part of Containing App with Dynamic Framework inside. There 2 @executable_path for Application target (application binary path is @executable_path) and for App Extension target(App Extension binary path is @executable_path)) - Framework2 example

//Application bundle(`.app` package) absolute path
/some_path/Application.аpp

//Application binary absolute path 
/some_path/Application.аpp/subfolder1

//Framework2 binary absolute path
/some_path/Application.аpp/Frameworks/Framework2.framework/subfolder1

//Framework2 @executable_path == Application binary absolute path <-
/some_path/Application.аpp/subfolder1

//Framework2 Dynamic Library Install Name 
@executable_path/../Frameworks/Framework2.framework/subfolder1

//Framework2 binary resolved absolute path by dyld
/some_path/Application.аpp/subfolder1/../Frameworks/Framework2.framework/subfolder1
/some_path/Application.аpp/Frameworks/Framework2.framework/subfolder1

@loader_path

@loader_path - relative to bundle which causes framework to be loaded. If it is an application than it will be the same as @executable_path
use case: framework with embedded framework - Framework3_1 with Framework3_2 inside

//Framework3_1 binary absolute path
/some_path/Application.аpp/Frameworks/Framework3_1.framework/subfolder1

//Framework3_2 binary absolute path
/some_path/Application.аpp/Frameworks/Framework3_1.framework/Frameworks/Framework3_2.framework/subfolder1

//Framework3_1 @executable_path == Application binary absolute path <-
/some_path/Application.аpp/subfolder1

//Framework3_1 @loader_path == Framework3_1 @executable_path <-
/some_path/Application.аpp/subfolder1

//Framework3_2 @executable_path == Application binary absolute path <-
/some_path/Application.аpp/subfolder1

//Framework3_2 @loader_path == Framework3_1 binary absolute path <-
/some_path/Application.аpp/Frameworks/Framework3_1.framework/subfolder1

//Framework3_2 Dynamic Library Install Name 
@loader_path/../Frameworks/Framework3_2.framework/subfolder1

//Framework3_2 binary resolved absolute path by dyld
/some_path/Application.аpp/Frameworks/Framework3_1.framework/subfolder1/../Frameworks/Framework3_2.framework/subfolder1
/some_path/Application.аpp/Frameworks/Framework3_1.framework/Frameworks/Framework3_2.framework/subfolder1

@rpath - Runpath Search Path

Framework2 example

Previously we had to setup a Framework to work with dyld. It is not convenient because the same Framework can not be used with a different configurations. Since this setup is made on Framework target side it is not possible to configure the same framework for different consumers(applications)

@rpath is a compound concept that relies on outer(Application) and nested(Dynamic framework) parts:

  • Application:

    • Runpath Search Paths(LD_RUNPATH_SEARCH_PATHS) - @rpath - defines a list of templates which will be substituted with @rpath. Consumer uses @rpath word to point on this list

       @executable_path/../Frameworks
      
    • Review Build Phases -> Embed Frameworks -> Destination, Subpath to be sure where exactly the embed framework is located

  • Dynamic Framework:

    • Dynamic Library Install Name(LD_DYLIB_INSTALL_NAME) - points that @rpath is used together with local bundle path to a binary

      @rpath/Framework2.framework/subfolder1
      
//Application Runpath Search Paths
@executable_path/../Frameworks

//Framework2 Dynamic Library Install Name
@rpath/Framework2.framework/subfolder1

//Framework2 binary resolved absolute path by dyld
//Framework2 @rpath is replaced by each element of Application Runpath Search Paths
@executable_path/../Frameworks/Framework2.framework/subfolder1
/some_path/Application.аpp/Frameworks/Framework2.framework/subfolder1

*../ - go to the parent of the current directory

otool - object file displaying tool

//-L print shared libraries used
//Application otool -L
@rpath/Framework2.framework/subfolder1/Framework2

//Framework2 otool -L
@rpath/Framework2.framework/subfolder1/Framework2

//-l print the load commands
//Application otool -l
LC_LOAD_DYLIB
@rpath/Framework2.framework/subfolder1/Framework2

LC_RPATH
@executable_path/../Frameworks

//Framework2 otool -l
LC_ID_DYLIB
@rpath/Framework2.framework/subfolder1/Framework2

install_name_tool change dynamic shared library install names using -rpath

CocoaPods uses use_frameworks![About] to regulate a Dynamic Linker

[Vocabulary]

[Java ClassLoader]

Upvotes: 20

Bogdan
Bogdan

Reputation: 231

If you also got this in console besides the log in answer:

Reason: no suitable image found. Did find:

Probably your framework is build for higher Deployment Version than your app. For example app is built for iOS 12, framework is built for iOS 14 and you run on iOS 12 device.

Upvotes: 0

Muhammad Awais Jamil
Muhammad Awais Jamil

Reputation: 406

In my case it was issue in

Run Script

I just removed Run Script and its working

Upvotes: 0

Alex.Pinhasov
Alex.Pinhasov

Reputation: 166

For me, I had to switch the XcodeKit.framework from "Do Not Embed" -> "Embed & Sign"

enter image description here

Upvotes: 3

Heider Sati
Heider Sati

Reputation: 2614

For SumUp Users, if you are loading the latest SumUpSDK.xcFramework, then you need to make sure that it's set to "Embed & Sign" from the application's General tab of the Target.

i.e. to reverse the above statement (making it easier to understand):

  1. Go to the "Project Navigator" (i.e. the first icon to show all project items etc)

  2. Select your project from the top of the tree.

  3. On the menu in the middle of the page (slightly to the right), select your application under "Targets"

  4. From the top-tab, select "General"

  5. Scroll down to "Frameworks, Libraries and Embedded Content"

  6. Select your Lib from the list

  7. Select "Embed & Sign" from the drop down list next to it.

  8. Clean

  9. Re-Build and run.

I hope this helps.

H

Upvotes: 1

Bozzo
Bozzo

Reputation: 338

In my case app crash only on real device and it occurred for standard library's. I tryied a lot of steps meintioned before, after 1h i just delete app from real device and install it again.

Upvotes: 0

whawhat
whawhat

Reputation: 175

Recently ran into this issue with importing CoreNFC on older iphones (e.g. iPhone 6) and Xcode (11.3.1). I was able to get it to work by

  1. In your Projects, select the target.
  2. Goto General tab on top.
  3. Under the 'Frameworks, Libraries and Embedded Content' section, add the framework (for me it was CoreNFC). Repeat for other targets.
  4. Click on Build Phases on top and expand 'Link Binary with Libraries'.
  5. Make the troublesome framework optional (from required).

This allowed me to compile for older/newer iPhones without making any code changes. I hope this helps other.

Upvotes: 11

St&#233;phane de Luca
St&#233;phane de Luca

Reputation: 13621

For any project or Framework project in Xcode that use pods, one easy way to avoid dynamic library (dylb) not to load is to set you pod file to ink in static mode. To do so, just make sure to don't write the following line in your pod file.

use_frameworks!

Once the line deleted from your file which you saved, simply run form the console:

$ pod update

Upvotes: 5

learner
learner

Reputation: 51

Although everyone is saying to embed the framework under the Embedded Binaries but still it is not working, because we are missing one important step here.

Here are the two right steps to add the binaries under Embedded Binaries tab :

  1. Remove the framework which is giving the error from the "Linked Frameworks and Libraries" under the General tab.

  2. Now add the removed framework only under the Embedded Binaries tab and that is all one would need to do.

Run it on the device and keep that smile ;)

Upvotes: 1

BaseZen
BaseZen

Reputation: 8718

Surprisingly, not all of the necessary pieces are documented here, at least for Xcode 8.

My case was a custom-built framework as part of the same workspace. It turns out it was being built incorrectly. Based on jeremyhu's last response to this thread:

https://forums.developer.apple.com/thread/4687

I had to set Dynamic Library Install Name Base (DYLIB_INSTALL_NAME_BASE) under Build Settings of the Framework Project and then rebuild it. It was incorrectly set to $(LOCAL_LIBRARY_DIR) and I had to change it to @rpath.

So in the link processing stage in the App Project, it was instructing the host App to dynamically load the framework at runtime from /Library/Frameworks/fw.Framework/fw (as in, the root of the runtime filesystem) rather than path-to-App/Frameworks/fw.Framework/fw

Regarding all the other settings: it does have to be in 3 places in Build Phases, but these are all set at once when you just add it to the Embedded Binaries setting of the General tab of the hosting App.

I did not have to set up an extra Copy Files phase, which seems intuitively redundant with respect to the embedding stage anyway. By checking the tail end of the build transcript we can assure that that's not necessary.

PBXCp /Users/xyz/Library/Developer/Xcode/DerivedData/MyApp-cbcnqafhywqkjufwsvbzckecmjjs/Build/Products/Debug-iphoneos/MyFramework.framework

[Many verbose lines removed, but it's clear from the simplified transcript in the Xcode UI.]

I still have no idea why Xcode set the DYLIB_INSTALL_NAME_BASE value incorrectly on me.

Upvotes: 12

Dawson
Dawson

Reputation: 4403

For iOS greater than or equal to 8

Under the target's General tab, in the Embedded Binaries section add the framework. This will copy the framework into the compiled so that it can be linked to at runtime.

enter image description here

Why is this happening? : because the framework you are linking to is compiled as a dynamically linked framework and thus is linked to at runtime.

** Note:** Embedding custom frameworks is only supported in iOS > 8 and thus an alternative solution that works on older versions of iOS follows.

For iOS less than 8

If you influence this framework (have access to the source code/build process) you may change this framework to be statically linked rather than dynamically linked. This will cause the code to be included in your compiled app rather than linked to at runtime and thus the framework will not have to be embedded.

** How:** Under the framework's Build Setting tab, in the Linking section, change the Mach-O Type to Static Library. You should now not need to include the framework under embedded binaries.

Static Framework

Including Assets: To include things such as images, audio, or xib/nib files I recommend creating a bundle (essentially a directory, more info here bit.ly/ios_bundle) and then load the assets from the bundle using NSBundle.

Upvotes: 273

vinay
vinay

Reputation: 361

In Xcode 11

I was facing the same issue

Changing "Do Not Embed" in General Tab > "Frameworks, Libraries, and Embedded Content" was still resulting the same error.

What did solved for me was adding the Framework in Build Phases Tab > Embed Frameworks section

--Updated---

I observed that in projects built in previous versions of Xcode Embed Frameworks Section is not available when running in Xcode 11, Find the below steps to achieve the solution:

1: First need to add the New Copy Files Phase under Build Phases tab.

enter image description here

2: Second change the name of the added phase to Embed Frameworks enter image description here

3: Change the destination to Frameworks.

enter image description here

4: Add the framework for which the error occurred.

enter image description here

Upvotes: 2

Matias Jurfest
Matias Jurfest

Reputation: 1389

Xcode 11

  1. Navigate to settings of your target and select General.
  2. Look for "Frameworks, Libraries, and Embedded Content"
  3. Keep "Do Not Embed" and make sure that all your targets (if you have more than one) have only set it's own framework and not others targets.

Upvotes: 1

glyvox
glyvox

Reputation: 58129

If you're using Xcode 11 or newer:

  1. Navigate to the settings of your target and select General.

Target Settings/General

  1. Scroll down to Frameworks, Libraries and Embedded Content.

  2. Make sure the Embed & Sign or Embed Without Signing value is selected for the Embed option if necessary.

Frameworks, Libraries and Embedded Content section

Upvotes: 18

NeverHopeless
NeverHopeless

Reputation: 11233

I created a framework using Swift3/Xcode 8.1 and was consuming it in an Objective-C/Xcode 8.1 project. To fix this issue I had to enable Always Embed Swift Standard Libraries option under Build Options.

Have a look at this screenshot:

enter image description here

Upvotes: 50

User18474728
User18474728

Reputation: 361

In my case, my project is written by objective-c and in the library there are Swift files. So I changed "Always Embed Swift Standard Libraries" in my project’s Build Settings tab to Yes and it became totally okay.

Upvotes: 4

Vittal Pai
Vittal Pai

Reputation: 3563

Try with changing flag ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES (in earlier xcode versions: Embedded Content Contains Swift Code) in the Build Settings from NO to YES.

Upvotes: 1

Brandon A
Brandon A

Reputation: 8289

Just dragging the framework into your project isn't going to be good enough. That is like being in the same ballpark but not being able to find your kids. Follow these steps:

1) Create your framework

  • Develop your framework.
  • Once your development is complete, COMMAND+B build your framework and ensure you receive "Build Succeeded".

enter image description here

2) Access your framework

  • Once your framework project successfully builds it will then be ready for you to access in your Products folder in your project.

enter image description here

  • Right click on your .framework and select "Show in Finder".

enter image description here

3) Place framework in your project

  • Drag and drop the .framework from your Finder window to your app project's "Framework" folder.

enter image description here

4) Configure app project for framework

  • Select the top level in your project

enter image description here

  • Choose your target

enter image description here

  • Go to "Build Phases", then "Link Binary with Libraries", and ensure that your framework is included with optional selected.

enter image description here

  • Still in "Build Phases", go to the upper left and select the + button. In the drop down choose "New Copy Files Phase".

enter image description here

  • Scroll down to the new "Copy Files" section and ensure that you set Destination to "Frameworks". Leave the subpath empty. Then click the + button at the bottom left.

enter image description here

  • You will be presented with your project hierarchy. Scroll down to the "Frameworks" folder that you added the framework to in step 3, or search for it in the search bar at the top. Select your framework and click "Add".

enter image description here

  • Ensure that your framework is included with "Code Sign On Copy" selected.

enter image description here

5) Clean, then run your project

  • COMMAND+SHIFT+K
  • COMMAND+R

Upvotes: 147

Shohin
Shohin

Reputation: 545

enter image description here

Resolved for me by unselecting "Copy only when installed" on Build Phases->Embed Frameworks

Upvotes: 8

atereshkov
atereshkov

Reputation: 4565

The same thing was when I've created a new Configuration and Build Scheme.

So the solution for me was to run

pod install

for this newly created Configuration.

Upvotes: 2

Apeksha Sahu
Apeksha Sahu

Reputation: 57

After trying all the methods available on internet and my own trial and error tricks 100 times. Finally I was able to solve it. – Apeksha Sahu 6 mins ago
Goto iTunes in Mac --> accounts-->Authorize this computer – Apeksha Sahu 5 mins ago
second step.... Goto developer in settings in iPad and iPhone and reindex with identifiers and clear trust computers everything. It worked for me........ ....... After reinstalling Mac OSHigh seria 10.13.15 version from Mac OS seirra beta latest version, to reinstalling Xcode latest version, after updating all certificates. etc etc etc... as many methods as you can think I did. – enter image description here

Upvotes: 1

john raja
john raja

Reputation: 589

  1. Go to file in xcode -> Workspace settings
  2. Click the arrow next to which appears /Users/apple/Library/Developer/Xcode/DerivedData
  3. Select the Derived data and move it to Trash.
  4. Quite the xcode and reopen it.
  5. Clean the project and run again.

Above steps resolved my issuses.

Upvotes: 0

Vineesh TP
Vineesh TP

Reputation: 7973

Add the framework in Embedded Binaries enter image description here

Then Clean and Build.

Upvotes: 13

Rajesh Kumar
Rajesh Kumar

Reputation: 821

If have development pod Delete your app from simulator install from pod -> clean - > run again...

Upvotes: 2

Andrea Leganza
Andrea Leganza

Reputation: 477

In my case the solution was to remove the compiled framework from the Embedded Binaries, which was a standalone project in the workspace, clean and rebuild it, and finally re-add to Embedded Binaries.

Upvotes: 9

jfalexvijay
jfalexvijay

Reputation: 3711

I got same kind of issue in iOS 9.x version

ISSUE IS: App crashes as soon as I open the app with below error.

dyld: Library not loaded: /System/Library/Frameworks/UserNotifications.framework/UserNotifications Referenced from: /var/containers/Bundle/Application/######/TestApp.app/TestApp Reason: image not found

I have resolved this issue by changing Required to Optional in Linked Frameworks and Libraries for UserNotifications.framework framework.

Upvotes: 28

Desert Rose
Desert Rose

Reputation: 3424

Firstly Try to build after Command+Option+Shift+K .If still fails then do below steps.

If anybody is facing this error in Xcode 8 then change your framework status to Optional instead of Required under the General Tab of your target.

enter image description here

Upvotes: 53

vladof81
vladof81

Reputation: 26499

In the target's General tab, there is an Embedded Binaries field. When you add the framework there the crash is resolved.

Reference is here on Apple Developer Forums.

Upvotes: 1081

NYC Tech Engineer
NYC Tech Engineer

Reputation: 1855

If you are using a third-party framework, and using Cocoapods as your dependency manager, try doing a pod install to refresh your pods.

This crash was occurring on a third-party library I was using, so glad the above solution worked for me, hope it works for you!

Upvotes: 8

Sam
Sam

Reputation: 5892

In case anyone is still experiencing this issue, despite following all the steps outlined in the many other answers, you may need to revoke and recreate your code signing certificate, as per the following:

https://developer.apple.com/library/ios/qa/qa1886/_index.html

Upvotes: -3

Related Questions