Calling fb_shutdown on exit (DNET-806)

Author: cincuranet

Provider/src/FirebirdSql.Data.FirebirdClient/Client/Managed/Version10/GdsDatabase.cs

@@ -243,6 +243,7 @@ public virtual void Detach()
 #warning Here
 				_xdrStream?.Dispose();
 
+#warning Same as in Dispose
 				_transactionCount = 0;
 				_handle = -1;
 				_dialect = 0;

Provider/src/FirebirdSql.Data.FirebirdClient/Client/Native/FbClientFactory.cs

@@ -23,6 +23,7 @@
 using System.Runtime.InteropServices;
 using System.Collections.Concurrent;
 using FirebirdSql.Data.Client.Native.Handle;
+using FirebirdSql.Data.Common;
 
 namespace FirebirdSql.Data.Client.Native
 {
@@ -66,13 +67,19 @@ static FbClientFactory()
 		/// </summary>
 		/// <param name="dllName">The name of the DLL to load (e.g. "fbembed", "C:\path\to\fbembed.dll", etc)</param>
 		/// <returns>A class that implements <see cref="IFbClient"/> and calls into the native library you specify.</returns>
-		public static IFbClient GetFbClient(string dllName)
+		public static IFbClient Create(string dllName)
 		{
 			if (string.IsNullOrEmpty(dllName))
 			{
 				dllName = DefaultDllName;
 			}
-			return cache.GetOrAdd(dllName, GenerateFbClient);
+			var createdNew = false;
+			var result = cache.GetOrAdd(dllName, s => { createdNew = true; return BuildFbClient(s); });
+			if (createdNew)
+			{
+				ShutdownHelper.RegisterFbClientShutdown(() => result.fb_shutdown(0, 0));
+			}
+			return result;
 		}
 
 		/// <summary>
@@ -86,7 +93,7 @@ public static IFbClient GetFbClient(string dllName)
 		/// <para>Note: To be completly generic, we actually reflect through <see cref="IFbClient"/>
 		/// to get the methods and parameters to generate.</para>
 		/// </remarks>
-		private static IFbClient GenerateFbClient(string dllName)
+		private static IFbClient BuildFbClient(string dllName)
 		{
 			// Get the initial TypeBuilder, with a "blank" class definition
 			var tb = CreateTypeBuilder(dllName);
@@ -253,7 +260,7 @@ private static IFbClient CreateInstance(TypeBuilder tb)
 		/// <returns>A <see cref="TypeBuilder"/> which we can use for building our type.</returns>
 		/// <remarks>
 		/// <para>Notice that we actually generate a new assembly for every different <c>dllName</c> that is
-		/// passed into <see cref="GenerateFbClient"/>. This might be inefficient, but since we're mostly
+		/// passed into <see cref="BuildFbClient"/>. This might be inefficient, but since we're mostly
 		/// only ever going to have one (or maybe two) different <c>dllName</c>s, it's not a big deal.</para>
 		/// </remarks>
 		private static TypeBuilder CreateTypeBuilder(string baseName)

Provider/src/FirebirdSql.Data.FirebirdClient/Client/Native/FesDatabase.cs

@@ -116,7 +116,7 @@ public bool ConnectionBroken
 
 		public FesDatabase(string dllName, Charset charset)
 		{
-			_fbClient = FbClientFactory.GetFbClient(dllName);
+			_fbClient = FbClientFactory.Create(dllName);
 			_handle = new DatabaseHandle();
 			_charset = charset ?? Charset.DefaultCharset;
 			_dialect = 3;

Provider/src/FirebirdSql.Data.FirebirdClient/Client/Native/FesServiceManager.cs

@@ -63,7 +63,7 @@ public Charset Charset
 
 		public FesServiceManager(string dllName, Charset charset)
 		{
-			_fbClient = FbClientFactory.GetFbClient(dllName);
+			_fbClient = FbClientFactory.Create(dllName);
 			_charset = charset ?? Charset.DefaultCharset;
 			_statusVector = new IntPtr[IscCodes.ISC_STATUS_LENGTH];
 		}

Provider/src/FirebirdSql.Data.FirebirdClient/Client/Native/IFbClient.cs

@@ -15,11 +15,9 @@
 
 //$Authors = Carlos Guzman Alvarez, Dean Harding, Jiri Cincura (jiri@cincura.net)
 
-using FirebirdSql.Data.Client.Native.Handle;
-using FirebirdSql.Data.Common;
 using System;
-using System.Diagnostics.Contracts;
 using System.Runtime.InteropServices;
+using FirebirdSql.Data.Client.Native.Handle;
 
 namespace FirebirdSql.Data.Client.Native
 {
@@ -33,8 +31,6 @@ public interface IFbClient
 	{
 #pragma warning disable IDE1006
 
-		#region Array Functions
-
 		IntPtr isc_array_get_slice(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref DatabaseHandle dbHandle,
@@ -53,10 +49,6 @@ IntPtr isc_array_put_slice(
 			byte[] sourceArray,
 			ref int sliceLength);
 
-		#endregion
-
-		#region Blob Functions
-
 		IntPtr isc_create_blob2(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref DatabaseHandle dbHandle,
@@ -96,10 +88,6 @@ IntPtr isc_close_blob(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref BlobHandle blobHandle);
 
-		#endregion
-
-		#region Database Functions
-
 		IntPtr isc_attach_database(
 			[In, Out] IntPtr[] statusVector,
 			short dbNameLength,
@@ -128,14 +116,11 @@ IntPtr isc_create_database(
 			short parmBufferLength,
 			byte[] parmBuffer,
 			short dbType);
+
 		IntPtr isc_drop_database(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref DatabaseHandle dbHandle);
 
-		#endregion
-
-		#region Transaction Functions
-
 		IntPtr isc_start_multiple(
 			[In, Out]   IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref TransactionHandle trHandle,
@@ -158,19 +143,15 @@ IntPtr isc_rollback_retaining(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref TransactionHandle trHandle);
 
-		#endregion
-
-		#region Cancel Functions
+		IntPtr fb_shutdown(
+			int timeout,
+			int reason);
 
 		IntPtr fb_cancel_operation(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref DatabaseHandle dbHandle,
 			int option);
 
-		#endregion
-
-		#region DSQL Functions
-
 		IntPtr isc_dsql_allocate_statement(
 			[In, Out] IntPtr[] statusVector,
 			[MarshalAs(UnmanagedType.I4)] ref DatabaseHandle dbHandle,
@@ -184,7 +165,7 @@ IntPtr isc_dsql_describe(
 
 		IntPtr isc_dsql_describe_bind(
 			[In, Out] IntPtr[] statusVector,
-			 [MarshalAs(UnmanagedType.I4)] ref StatementHandle stmtHandle,
+			[MarshalAs(UnmanagedType.I4)] ref StatementHandle stmtHandle,
 			short daVersion,
 			IntPtr xsqlda);
 
@@ -231,14 +212,6 @@ IntPtr isc_dsql_sql_info(
 			short bufferLength,
 			byte[] buffer);
 
-		IntPtr isc_vax_integer(
-			byte[] buffer,
-			short length);
-
-		#endregion
-
-		#region Services Functions
-
 		IntPtr isc_service_attach(
 			[In, Out] IntPtr[] statusVector,
 			short serviceLength,
@@ -269,8 +242,6 @@ IntPtr isc_service_query(
 			short bufferLength,
 			byte[] buffer);
 
-		#endregion
-
 #pragma warning restore IDE1006
 	}
 }

Provider/src/FirebirdSql.Data.FirebirdClient/Common/ShutdownHelper.cs

@@ -0,0 +1,56 @@
+/*
+ *    The contents of this file are subject to the Initial
+ *    Developer's Public License Version 1.0 (the "License");
+ *    you may not use this file except in compliance with the
+ *    License. You may obtain a copy of the License at
+ *    https://github.com/FirebirdSQL/NETProvider/blob/master/license.txt.
+ *
+ *    Software distributed under the License is distributed on
+ *    an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
+ *    express or implied. See the License for the specific
+ *    language governing rights and limitations under the License.
+ *
+ *    All Rights Reserved.
+ */
+
+//$Authors = Jiri Cincura (jiri@cincura.net)
+
+using System;
+using System.Collections.Concurrent;
+
+namespace FirebirdSql.Data.Common
+{
+	internal static class ShutdownHelper
+	{
+		static ConcurrentBag<Action> _pools;
+		static ConcurrentBag<Action> _fbClients;
+
+		static ShutdownHelper()
+		{
+			_pools = new ConcurrentBag<Action>();
+			_fbClients = new ConcurrentBag<Action>();
+#if !NETSTANDARD1_6
+			AppDomain.CurrentDomain.DomainUnload += (sender, e) => HandleShutdown();
+			AppDomain.CurrentDomain.ProcessExit += (sender, e) => HandleShutdown();
+#endif
+		}
+
+		internal static void RegisterPoolCleanup(Action item)
+		{
+			_pools.Add(item);
+		}
+
+		internal static void RegisterFbClientShutdown(Action item)
+		{
+			_fbClients.Add(item);
+		}
+
+		static void HandleShutdown()
+		{
+			foreach (var item in _pools)
+				item();
+			foreach (var item in _fbClients)
+				item();
+		}
+	}
+}

Provider/src/FirebirdSql.Data.FirebirdClient/FirebirdClient/FbConnectionPoolManager.cs

@@ -184,10 +184,7 @@ FbConnectionInternal CreateNewConnectionIfPossibleImpl(FbConnectionString connec
 		static FbConnectionPoolManager()
 		{
 			Instance = new FbConnectionPoolManager();
-#if !NETSTANDARD1_6
-			AppDomain.CurrentDomain.DomainUnload += (sender, e) => Instance.Dispose();
-			AppDomain.CurrentDomain.ProcessExit += (sender, e) => Instance.Dispose();
-#endif
+			ShutdownHelper.RegisterPoolCleanup(Instance.Dispose);
 		}
 
 		FbConnectionPoolManager()