Changes between Version 1 and Version 2 of FDORfc4

Timestamp:

04/19/07 10:04:21 (18 years ago)

Author:

gregboone

Comment:

--

FDORfc4

@@ -34 +34 @@
 If a client installs both ArcSDE versions, ArcSDEProvider92.dll will be loaded and used. The ArcSDE 9.1 client will not be used.
 
-== Implementation Details ==
+== Implementation Overview ==
 
 To implement the above recommendations, a design has been proposed that would result in the modification of the FDO ArcSDE build process so that it creates two separate provider libraries. Each library in turn will link against separate client SDK versions of ArcSDE 9.1 and 9.2. 
@@ -50 +50 @@
 In case user has only one version of the ArcSDE client installed, the location must be specified using %SDEHOME%
 
-
+== The Provider 'Loader Library' ==
+
+Here is example code on how the loader dll logic will operate.
+
+Windows:
+
+{{{
+
+typedef FdoIConnection* (*CreateConnectionProc)();
+
+#ifdef _WIN32
+
+#ifdef ARCSDEPROVIDER_EXPORTS
+#define FDOSDE_API __declspec(dllexport)
+#else
+#define FDOSDE_API __declspec(dllimport)
+#endif
+
+class ArcSDELoaderLibrary
+{
+private:
+    HMODULE m_hArcSDE;
+
+public:
+    ArcSDELoaderLibrary()
+    {
+        m_hArcSDE = NULL;
+        try
+        {
+            HMODULE hmod = ::LoadLibraryW(L"sde.dll");
+            if (hmod != NULL)
+            {
+                ::FreeLibrary(hmod);
+                m_hArcSDE = ::LoadLibraryW(L"ArcSDEProvider92.dll");
+                // in case load ArcSDEProvider92.dll fails try to load 91
+                if (m_hArcSDE == NULL)
+                    m_hArcSDE = ::LoadLibraryW(L"ArcSDEProvider91.dll");
+            }
+            else
+                m_hArcSDE = ::LoadLibraryW(L"ArcSDEProvider91.dll");
+        }
+        catch(...){}
+    }
+    HMODULE GetLibraryHandle()
+    {
+        return m_hArcSDE;
+    }
+    ~ArcSDELoaderLibrary()
+    {
+        try
+        {
+            if (m_hArcSDE != NULL)
+                ::FreeLibrary(m_hArcSDE);
+        }
+        catch(...){}
+    }
+};
+
+static ArcSDELoaderLibrary arcSDEloader;
+// external access to connection for client services
+extern "C" FDOSDE_API FdoIConnection* CreateConnection ()
+{
+    CreateConnectionProc procCreateConn;
+    HMODULE hArc = arcSDEloader.GetLibraryHandle();
+
+    if (hArc != NULL)
+    {
+        procCreateConn = (CreateConnectionProc)::GetProcAddress (hArc, "CreateConnection");
+        if (procCreateConn != NULL)
+            return procCreateConn();
+    }
+    return NULL;
+}
+
+
+}}}
+
+Linux:
+
+{{{
+
+class ArcSDELoaderLibrary
+{
+private:
+    void* m_hArcSDE;
+
+public:
+    ArcSDELoaderLibrary()
+    {
+        m_hArcSDE = NULL;
+        try
+        {
+            void* hmod = dlopen("libsde.so", RTLD_NOW);
+            if (hmod != NULL)
+            {
+                dlclose(hmod);
+                m_hArcSDE = dlopen("libArcSDEProvider92.so", RTLD_NOW);
+                // in case load libArcSDEProvider92.so fails try to load 91
+                if (m_hArcSDE == NULL)
+                    m_hArcSDE = dlopen("libArcSDEProvider91.so", RTLD_NOW);
+            }
+            else
+                m_hArcSDE = dlopen("libArcSDEProvider91.so", RTLD_NOW);
+        }
+        catch(...){}
+    }
+    void* GetLibraryHandle()
+    {
+        return m_hArcSDE;
+    }
+    ~ArcSDELoaderLibrary()
+    {
+        try
+        {
+            if (m_hArcSDE != NULL)
+                dlclose(m_hArcSDE);
+        }
+        catch(...){}
+    }
+};
+
+static ArcSDELoaderLibrary arcSDEloader;
+
+// external access to connection for client services
+extern "C" FDOSDE_API FdoIConnection* CreateConnection ()
+{
+    CreateConnectionProc procCreateConn;
+    void* hArc = arcSDEloader.GetLibraryHandle();
+
+    if (hArc != NULL)
+    {
+        procCreateConn = (CreateConnectionProc)dlsym (hArc, "CreateConnection");
+        if (procCreateConn != NULL)
+            return procCreateConn();
+    }
+    return NULL;
+}
+
+}}}
+
+=== Build Script Changes === 
+
+In order to support the above proposal, the ArcSDE build scripts must be modified.
+
+It is known the open source user can have ArcSDE 9.1 client, ArcSDE 9.2 client or both and the build scripts must handle this.
+
+If a user has both clients we must build both versions of provider, but if he has only one version we must detect at run time which one it is and build the right provider.
+
+The unit test can be based on ArcSDE 9.1 client or ArcSDE 9.2 client so here the user must decide which one to use.
+In order to handle this, a new environment variable was created to specify the version used by the unit test, named SDEVER_ARCUNITTEST.
+
+Windows side:
+
+If a user has only one version of ArcSDE client he must set the environment variable SDEHOME to target the location of ArcSDE client SDK.
+
+If the user has both versions of ArcSDE clients he must copy/install ArcSDE 9.1 client to:
+
+%FDOTHIRDPARTY%\ESRI\ArcSDEClient91\Windows 
+
+…and ArcSDE 9.2 client to 
+
+%FDOTHIRDPARTY%\ESRI\ArcSDEClient92\Windows 
+
+…to be able to build both versions of provider.
+
+Also he must set the environment variable %SDEHOME% to target the location of ArcSDE client version used in the unit test.
+
+The valid values for SDEVER_ARCUNITTEST will be 91 and 92.
+
+The ArcSDE Provider solution file, ArcSDE.sln, will be modified to include multiple configurations to allow user to build the provider depending of the ArcSDE clients installed. The configurations that will be supported are as follows:
+
+Debug
+Debug91Only 
+Debug92Only
+Release 
+Release91Only
+Release92Only
+
+The following lines will be added to the Windows build scripts to detect the correct build configuration:
+
+{{{
+
+SET ARCSDEVERSIONACTIVE=9
+
+:start_exbuild
+
+if not ("%SDEVER_ARCUNITTEST%")==("") goto start_setbuild
+if exist "%SDEHOME%\bin\sde.dll" SET SDEVER_ARCUNITTEST=92
+if exist "%SDEHOME%\bin\sde91.dll" SET SDEVER_ARCUNITTEST=91
+
+:start_setbuild
+
+if exist "%FDOTHIRDPARTY%\ESRI\ArcSDEClient91\Windows\bin\sde91.dll" SET ARCSDEVERSIONACTIVE=%ARCSDEVERSIONACTIVE%1
+
+if exist "%FDOTHIRDPARTY%\ESRI\ArcSDEClient92\Windows\bin\sde.dll" SET ARCSDEVERSIONACTIVE=%ARCSDEVERSIONACTIVE%2
+
+if "%ARCSDEVERSIONACTIVE%"=="912" SET ARCSDEVERSIONACTIVE=%TYPEBUILDARCSDE%
+if "%ARCSDEVERSIONACTIVE%"=="91" SET ARCSDEVERSIONACTIVE=%TYPEBUILDARCSDE%91Only
+if "%ARCSDEVERSIONACTIVE%"=="92" SET ARCSDEVERSIONACTIVE=%TYPEBUILDARCSDE%92Only
+
+if "%TYPEACTIONARCSDE%"=="clean" SET MSACTIONARCSDE=Clean
+if "%TYPEACTIONARCSDE%"=="install" goto install_files_ArcSDE
+
+echo %MSACTIONARCSDE% %TYPEBUILDARCSDE% ArcSDE provider dlls
+SET FDOACTIVEBUILD=%cd%\Src\ArcSDE
+cscript //Nologo //job:prepare preparebuilds.wsf
+pushd Src
+
+msbuild ArcSDE_temp.sln /t:%MSACTIONARCSDE% /p:Configuration=%ARCSDEVERSIONACTIVE% /p:Platform="Win32" /nologo /consoleloggerparameters:NoSummary
+
+
+}}}
+
+Linux side:
+
+The valid values for SDEVER_ARCUNITTEST will be 91 and empty. 
+
+Building different versions of the provider will be done using an environment variable and an optional parameter in the configure script.
+
+If the user has only one version of ArcSDE client he must set the environment variable SDEHOME to target the location of ArcSDE client SDK.
+
+If the user has both versions of ArcSDE clients he must copy/install ArcSDE 9.1 client to 
+
+$FDOTHIRDPARTY/ESRI/ArcSDEClient91/Linux 
+
+… and ArcSDE 9.2 client to 
+
+$FDOTHIRDPARTY/ESRI/ArcSDEClient92/Linux 
+
+…to be able to build both versions of provider.
+
+Also, he must set the environment variable $SDEHOME to target the location of the ArcSDE client version used in the unit tests.
+
+=== Issues ===
+
+We are still working on finalizing the changes required to the Linux build scripts.