Further significant revision of extension interface, now with class; still some TODOs

Author: heplesser

CMakeLists.txt

@@ -67,7 +67,6 @@ set( with-modelset "full" CACHE STRING "The modelset to include. Sample configur
 set( with-models OFF CACHE STRING "The models to include as a semicolon-separated list of model headers (without the .h extension). This option is mutually exclusive with -Dwith-modelset. [default=OFF]." )
 set( tics_per_ms "1000.0" CACHE STRING "Specify elementary unit of time [default=1000 tics per ms]." )
 set( tics_per_step "100" CACHE STRING "Specify resolution [default=100 tics per step]." )
-set( external-modules OFF CACHE STRING "External NEST modules to be linked in, separated by ';', [default=OFF]." )
 set( with-detailed-timers OFF CACHE STRING "Build with detailed internal time measurements [default=OFF]. Detailed timers can affect the performance." )
 set( target-bits-split "standard" CACHE STRING "Split of the 64-bit target neuron identifier type [default='standard']. 'standard' is recommended for most users. If running on more than 262144 MPI processes or more than 512 threads, change to 'hpc'." )
 
@@ -136,7 +135,6 @@ nest_process_with_libraries()
 nest_process_with_includes()
 nest_process_with_defines()
 nest_process_static_libraries()
-nest_process_external_modules()
 nest_process_tics_per_ms()
 nest_process_tics_per_step()
 nest_process_with_libltdl()

cmake/ConfigureSummary.cmake

@@ -43,18 +43,6 @@ function( NEST_PRINT_CONFIG_SUMMARY )
     message( "Built-in modelset   : ${with-modelset}" )
   endif ()
 
-  message( "" )
-  if ( external-modules )
-    message( "User modules        : ${external-modules}" )
-    foreach ( mod ${external-modules} )
-      message( "  ${mod}:" )
-      message( "    Header          : ${${mod}_EXT_MOD_INCLUDE}" )
-      message( "    Library         : ${${mod}_EXT_MOD_LIBRARY}" )
-    endforeach ()
-  else ()
-    message( "User modules        : None" )
-  endif ()
-
   message( "" )
   if ( HAVE_PYTHON )
     message( "Python bindings     : Yes (Python ${Python_VERSION}: ${PYTHON})" )

cmake/ProcessOptions.cmake

@@ -222,43 +222,6 @@ function( NEST_PROCESS_STATIC_LIBRARIES )
   endif ()
 endfunction()
 
-function( NEST_PROCESS_EXTERNAL_MODULES )
-  if ( external-modules )
-    # headers from external modules will be installed here
-    include_directories( "${CMAKE_INSTALL_FULL_INCLUDEDIR}" )
-
-    # put all external libs into this variable
-    set( EXTERNAL_MODULE_LIBRARIES )
-    # put all external headers into this variable
-    set( EXTERNAL_MODULE_INCLUDES )
-    foreach ( mod ${external-modules} )
-      # find module header
-      find_file( ${mod}_EXT_MOD_INCLUDE
-          NAMES ${mod}module.h
-          HINTS "${CMAKE_INSTALL_FULL_INCLUDEDIR}/${mod}module"
-          )
-      if ( ${mod}_EXT_MOD_INCLUDE STREQUAL "${mod}_EXT_MOD_INCLUDE-NOTFOUND" )
-         printError( "Cannot find header for external module '${mod}'. "
-          "Should be '${CMAKE_INSTALL_FULL_INCLUDEDIR}/${mod}module/${mod}module.h' ." )
-      endif ()
-      list( APPEND EXTERNAL_MODULE_INCLUDES ${${mod}_EXT_MOD_INCLUDE} )
-
-      # find module library
-      find_library( ${mod}_EXT_MOD_LIBRARY
-          NAMES ${mod}module
-          HINTS "${CMAKE_INSTALL_FULL_LIBDIR}/nest"
-          )
-      if ( ${mod}_EXT_MOD_LIBRARY STREQUAL "${mod}_EXT_MOD_LIBRARY-NOTFOUND" )
-        printError( "Cannot find library for external module '${mod}'." )
-      endif ()
-      list( APPEND EXTERNAL_MODULE_LIBRARIES "${${mod}_EXT_MOD_LIBRARY}" )
-    endforeach ()
-
-    set( EXTERNAL_MODULE_LIBRARIES ${EXTERNAL_MODULE_LIBRARIES} PARENT_SCOPE )
-    set( EXTERNAL_MODULE_INCLUDES ${EXTERNAL_MODULE_INCLUDES} PARENT_SCOPE )
-  endif ()
-endfunction()
-
 function( NEST_PROCESS_TICS_PER_MS )
   # Set tics per ms / step
   if ( tics_per_ms )

nest/CMakeLists.txt

@@ -56,10 +56,10 @@ set_target_properties( nest_lib
 
 target_link_libraries( nest
     nestutil nestkernel sli_lib sli_readline models
-    ${EXTERNAL_MODULE_LIBRARIES} OpenMP::OpenMP_CXX )
+    OpenMP::OpenMP_CXX )
 
 target_link_libraries( nest_lib
-    nestutil nestkernel sli_lib models ${EXTERNAL_MODULE_LIBRARIES}
+    nestutil nestkernel sli_lib models
     OpenMP::OpenMP_CXX )
 
 target_include_directories( nest PRIVATE
@@ -88,7 +88,6 @@ target_include_directories( nest_lib PRIVATE
     ${Python_INCLUDE_DIRS}
     )
 
-
 if ( HAVE_PYTHON )
   target_compile_definitions( nest_lib PRIVATE
       -D_IS_PYNEST

nestkernel/CMakeLists.txt

@@ -115,6 +115,7 @@ set ( nestkernel_sources
       spatial.h spatial.cpp
       stimulation_backend.h
       buffer_resize_log.h buffer_resize_log.cpp
+      nest_extension_interface.h
       )
 
 

nestkernel/module_manager.cpp

@@ -29,6 +29,7 @@
 
 // Includes from nestkernel:
 #include "kernel_manager.h"
+#include "nest_extension_interface.h"
 
 // Includes from sli:
 #include "arraydatum.h"
@@ -59,7 +60,8 @@ ModuleManager::finalize( const bool )
   // unload all loaded modules
   for ( const auto& [ name, handle ] : modules_ )
   {
-    lt_dlclose( handle );
+    // TODO: If this is not commented out, unloading leads to a seg-fault.
+    // lt_dlclose( handle );
   }
   modules_.clear();
 }
@@ -112,8 +114,7 @@ ModuleManager::install( const std::string& name )
   }
 
   // see if we can find the register_components symbol in the module
-  using reg_func_type = void();
-  reg_func_type* register_components = ( reg_func_type* ) lt_dlsym( hModule, "register_components" );
+  NESTExtensionInterface* extension = reinterpret_cast< NESTExtensionInterface* >( lt_dlsym( hModule, "module" ) );
   char* errstr = ( char* ) lt_dlerror();
   if ( errstr )
   {
@@ -128,7 +129,7 @@ ModuleManager::install( const std::string& name )
   // all is well an we can register module components
   try
   {
-    register_components();
+    extension->init();
   }
   catch ( std::exception& e )
   {
@@ -140,7 +141,7 @@ ModuleManager::install( const std::string& name )
   // add the handle to list of loaded modules
   modules_[ name ] = hModule;
 
-  LOG( M_INFO, "Install", ( "loaded module " + name ).c_str() );
+  LOG( M_INFO, "Install", ( "loaded module " + extension->name() ).c_str() );
 }
 
 } // namespace nest

nestkernel/nest_extension_interface.h

@@ -0,0 +1,81 @@
+/*
+ *  nest_extension_interface.h
+ *
+ *  This file is part of NEST.
+ *
+ *  Copyright (C) 2004 The NEST Initiative
+ *
+ *  NEST is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  NEST is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef NEST_EXTENSION_INTERFACE_H
+#define NEST_EXTENSION_INTERFACE_H
+
+// Includes from nestkernel; placed here so module developer does not need to
+// include them manually
+#include "config.h"
+#include "connection_manager_impl.h"
+#include "connector_model_impl.h"
+#include "exceptions.h"
+#include "genericmodel.h"
+#include "genericmodel_impl.h"
+#include "io_manager_impl.h"
+#include "kernel_manager.h"
+#include "model.h"
+#include "model_manager_impl.h"
+#include "nest.h"
+#include "nest_impl.h"
+#include "nestmodule.h"
+#include "target_identifier.h"
+
+// C++ includes
+#include <string>
+
+/**
+ * Interface for NEST Extenstion Modules.
+ *
+ * All NEST Extension Modules must be derived from this interface class.
+ *
+ * Method init() will be called after the module is loaded.
+ *
+ * The constructor should be empty.
+ */
+
+class NESTExtensionInterface
+{
+public:
+  virtual ~NESTExtensionInterface()
+  {
+  }
+
+  /**
+   * Initialize module, register all components with kernel
+   */
+  virtual void init() = 0;
+
+  //! Name of module
+  virtual std::string name() = 0;
+
+  //! Contact information
+  virtual std::string contact() = 0;
+
+  //! Website
+  virtual std::string url() = 0;
+
+  //! Permanent URI
+  virtual std::string uri() = 0;
+};
+
+#endif // #ifndef NEST_EXTENSION_INTERFACE_H

pynest/CMakeLists.txt

@@ -54,7 +54,7 @@ if ( HAVE_PYTHON )
   endif ()
 
   target_link_libraries( pynestkernel
-      nest_lib nestutil nestkernel sli_lib models ${EXTERNAL_MODULE_LIBRARIES}
+      nest_lib nestutil nestkernel sli_lib models
       )
 
   target_include_directories( pynestkernel PRIVATE