Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

.net standard library fails in .net core but not in framework

We have to use api from 3rd party vendor(perforce). Till today, we were able to reference and use that API in .net framework application. But, now we are refactoring our product and of course we decided to use new .net environment, which is .net core 2.2. As, Perforce didn't publish that library for .net core, we decided to port that library to .net standard.

So, in a nutshell we downloaded source code, ported, and added as a reference in .net core project.

So far, so good. A weird thing is that, after some usage of that library we are getting ExecutionEngineException from that library, which triggers Environment.Failfast and terminates application.

One more important information is that library uses another native library(p4bridge.dll).

The exception is so:

FailFast:
A callback was made on a garbage collected delegate of type 'p4netapi!Perforce.P4.P4CallBacks+LogMessageDelegate::Invoke'.

   at Perforce.P4.P4Bridge.RunCommandW(IntPtr, System.String, UInt32, Boolean, IntPtr[], Int32)
   at Perforce.P4.P4Bridge.RunCommandW(IntPtr, System.String, UInt32, Boolean, IntPtr[], Int32)
   at Perforce.P4.P4Server.RunCommand(System.String, UInt32, Boolean, System.String[], Int32)
   at Perforce.P4.P4Command.RunInt(Perforce.P4.StringList)
   at Perforce.P4.P4CommandResult..ctor(Perforce.P4.P4Command, Perforce.P4.StringList)
   at Perforce.P4.P4Command.Run(Perforce.P4.StringList)
   at Perforce.P4.Client.runFileListCmd(System.String, Perforce.P4.Options, System.String, Perforce.P4.FileSpec[])
   at Perforce.P4.Client.SyncFiles(System.Collections.Generic.IList`1<Perforce.P4.FileSpec>, Perforce.P4.Options)

I am already aware of the message related to garbage collected delegate. It seems, at some place pointer to the delegate is passed to unmanaged library and then GC collected it.

We take a look to the source code of that api. And we saw some possible places which can be reason for that error. But, this is just a thought.

While investigating the failure, we created another .net framework application which references to that ported library, and then we didn't came across any error in .net framework.

My questions are:

  1. Is there any difference between .net framework and .net core in terms of garbage collector mechanism?
  2. How is that possible that, .net framework and .net core reacts to the same library in a different ways?
like image 301
Farhad Jabiyev Avatar asked Dec 12 '19 09:12

Farhad Jabiyev


People also ask

Can I use .NET standard library in .NET Core?

NET Core supports the . NET Standard Library, which allows your library to be called by any . NET platform that supports that version of the . NET Standard Library.

Is .NET standard compatible with .NET Framework?

NET Framework, Mono, Xamarin or Unity has to implement - at minimum - to support that version of the Standard. For library authors targeting . NET Standard provides the same feature set across all supported platforms - if it compiles to . NET Standard it'll very likely run on those frameworks.

What is the difference between .NET Core and .NET Framework and .NET standard?

. Net Core does not support desktop application development and it rather focuses on the web, windows mobile, and windows store. . Net Framework is used for the development of both desktop and web applications as well as it supports windows forms and WPF applications.

Is .NET Framework 4.8 compatible with standard?

You cannot consume a . Net Standard 2.1 assembly in any . Net Framework Version because the . NET Framework (even the last ever version, 4.8) does not implement .

Why can't I use my libraries with NET 5+?

Thank you. Several technologies available to .NET Framework libraries aren't available for use with .NET 5+ (and .NET Core), such as app domains, remoting, and code access security (CAS). If your libraries rely on one or more of the technologies listed on this page, consider the alternative approaches mentioned.

Can I use WPF libraries in NET Core?

Because .NET Core 2.0 implements .NET Standard 2.0, it also has the compatibility mode for referencing .NET Framework libraries. However, not all .NET Framework libraries will work on all .NET implementations. For example, they might use Windows Forms or WPF APIs.

Why do so many general-purpose libraries only target the NET Framework?

However, many of the general-purpose libraries only target .NET Framework because they were created when .NET Standard simply didn’t exist yet. With .NET Standard 2.0, the API set is large enough so that most, if not all, of the general-purpose libraries can target .NET Standard.

Which version of the NET Framework should I use to build apps?

If you want to build a Apps that will support .NET framework V4.5, Windows, iOS, Android, Linux, Mono and UWP then you should go for .NET standard version 1.0.


1 Answers

I thought to post answer to my question as I already solved the issue. And as you are reading my answer now it means that you have faced with a similar problem. First of all, I want to thank to @MarcGravell for his comments and recommend to you to read the comments.

At first, want to summarize answer to the 2nd question:

How is that possible that, .net framework and .net core reacts to the same library in a different ways?

To be honest, from the first glance I was thinking that .net standard library will behave itself in a same manner everywhere. But, of course I was wrong.

Let's start by "defintion" of .Net Standard. .NET Standard is nothing but a specification (think of it as an Interface), it just only declares what types and APIs are exposed by a specific platform depending on is version.

If you will take a look, you will see that your standard library references the .NET Standard SDK that contains a netstandard.dll containing the APIs or, to better say, the contract, we can use from within the library project. If you will take a look, to the your standard library with Ildasm.exe, you will see that it is using .netstandard.dll.

enter image description here

And let's check how it is used by our core and framework apps. And in core it works better than framework.

I am always a fan of diagrams:

enter image description here

As you see in the diagram, both core and framework apps reference their own netstandard.dll. And those libraries are built based on the type forwardingconcept. For core apps, BCL types are provided by System.Runtime.dll, while in case of framework apps BCLtypes are provided by mscorlib.dll. So, two different implementations.

For example, here is the IL code of .netstandard library which will be used by core apps:

enter image description here

Read more about type forwarding from msdn.

Source of details about .NET Standard.


And now a bit regarding to my first question:

Is there any difference between .net framework and .net core in terms of garbage collector mechanism?

Actually it must not be surprise that Microsoft continues to evolve GC mechanism.


And now how I solved the issue:

Good thing was that library which I ported to standard was open source. I investigated the issue, and in a nutshell they are passing delegate pointer to the unmanaged library. And that unmanaged library saves the pointer and tries to use it during some lifetime which is longer that the lifetime of that pointer. Actually, the interesting point is that framework GC is not collecting that delegate somehow and that's why no exception in framework side. But, in case of core GC collects that delegate and creates reason to the failure. I did change the way how I set that field and it works now. I declared that field as static and initialize it inside static constructor, so lifetime of that delegate is as long as app lifetime.

like image 125
Farhad Jabiyev Avatar answered Oct 09 '22 22:10

Farhad Jabiyev