CMake / build system improvements + remove outdated warning (#517)

* Include PR#95 and PR#96 in hpc-coding-conventions
  - Use the new `cpp_cc_build_time_copy` helper function to 
    help set up build rules properly.
* Remove outdated warning for VectorPlay support in GPUs.
* Improve build dependency declarations.

Author: olupton

.cmake-format.changes.yaml

@@ -4,3 +4,8 @@ additional_commands:
     flags: ["STATIC", "SHARED", "MODULE", "EXCLUDE_FROM_ALL"]
     kwargs:
       OPTIONS: '*'
+  cpp_cc_build_time_copy:
+    flags: ['NO_TARGET']
+    kwargs:
+      INPUT: '1'
+      OUTPUT: '1'

CMake/hpc-coding-conventions

@@ -53,28 +53,51 @@ set(KINDERIV_HEADER_FILE "${CMAKE_CURRENT_BINARY_DIR}/_kinderiv.h")
 
 set(NMODL_UNITS_FILE "${CMAKE_BINARY_DIR}/share/mod2c/nrnunits.lib")
 
-# copy inbuilt mod files {source}/coreneuron/mechanism/mech/modfile/*.mod to
-# {build_dir}/share/modfile/
+# =============================================================================
+# Copy files that are required by nrnivmodl-core to the build tree at build time.
+# =============================================================================
+cpp_cc_build_time_copy(
+  INPUT "${CMAKE_CURRENT_SOURCE_DIR}/${MODFUNC_PERL_SCRIPT}"
+  OUTPUT "${CMAKE_BINARY_DIR}/share/coreneuron/mod_func.c.pl"
+  NO_TARGET)
+cpp_cc_build_time_copy(
+  INPUT "${KINDERIV_PYTHON_SCRIPT}"
+  OUTPUT "${CMAKE_BINARY_DIR}/share/coreneuron/kinderiv.py"
+  NO_TARGET)
+cpp_cc_build_time_copy(
+  INPUT "${CMAKE_CURRENT_SOURCE_DIR}/${DIMPLIC_CODE_FILE}"
+  OUTPUT "${CMAKE_BINARY_DIR}/share/coreneuron/dimplic.cpp"
+  NO_TARGET)
+cpp_cc_build_time_copy(
+  INPUT "${CMAKE_CURRENT_SOURCE_DIR}/${ENGINEMECH_CODE_FILE}"
+  OUTPUT "${CMAKE_BINARY_DIR}/share/coreneuron/enginemech.cpp"
+  NO_TARGET)
+set(nrnivmodl_core_dependencies
+    "${CMAKE_BINARY_DIR}/share/coreneuron/mod_func.c.pl"
+    "${CMAKE_BINARY_DIR}/share/coreneuron/kinderiv.py"
+    "${CMAKE_BINARY_DIR}/share/coreneuron/dimplic.cpp"
+    "${CMAKE_BINARY_DIR}/share/coreneuron/enginemech.cpp")
+# Set up build rules that copy builtin mod files from
+# {source}/coreneuron/mechanism/mech/modfile/*.mod to {build_dir}/share/modfile/
 file(GLOB builtin_modfiles
      "${CORENEURON_PROJECT_SOURCE_DIR}/coreneuron/mechanism/mech/modfile/*.mod")
-# get the corresponding list of paths to the modfiles in the build directory
-set(builtin_modfiles_in_build_dir)
 foreach(builtin_modfile ${builtin_modfiles})
+  # Construct the path in the build directory.
   get_filename_component(builtin_modfile_name "${builtin_modfile}" NAME)
-  list(APPEND builtin_modfiles_in_build_dir
-       "${CMAKE_BINARY_DIR}/share/modfile/${builtin_modfile_name}")
+  set(modfile_build_path "${CMAKE_BINARY_DIR}/share/modfile/${builtin_modfile_name}")
+  # Create a build rule to copy the modfile there.
+  cpp_cc_build_time_copy(
+    INPUT "${builtin_modfile}"
+    OUTPUT "${modfile_build_path}"
+    NO_TARGET)
+  list(APPEND nrnivmodl_core_dependencies "${modfile_build_path}")
 endforeach()
-file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/share/modfile")
-# set up a build rule that ensures the modfiles in the build directory are updated if their
-# counterparts in the source directory are touched
-add_custom_command(
-  OUTPUT ${builtin_modfiles_in_build_dir}
-  DEPENDS ${builtin_modfiles}
-  COMMAND ${CMAKE_COMMAND} -E copy_if_different ${builtin_modfiles}
-          "${CMAKE_BINARY_DIR}/share/modfile")
-add_custom_target(copy-builtin-modfiles ALL DEPENDS ${builtin_modfiles_in_build_dir})
+add_custom_target(coreneuron-copy-nrnivmodl-core-dependencies ALL
+                  DEPENDS ${nrnivmodl_core_dependencies})
+# Store the build-tree modfile paths in a cache variable; these are an implicit dependency of
+# nrnivmodl-core.
 set(CORENEURON_BUILTIN_MODFILES
-    "${builtin_modfiles_in_build_dir}"
+    "${nrnivmodl_core_dependencies}"
     CACHE STRING "List of builtin modfiles that nrnivmodl-core implicitly depends on" FORCE)
 
 # =============================================================================
@@ -201,15 +224,6 @@ set(CORENRN_LINK_LIBS
     "${CORENRN_LINK_LIBS}"
     PARENT_SCOPE)
 
-# =============================================================================
-# Copy files for nrnivmodl-core workflow during build time
-# =============================================================================
-
-configure_file(${MODFUNC_PERL_SCRIPT} ${CMAKE_BINARY_DIR}/share/coreneuron/mod_func.c.pl COPYONLY)
-configure_file(${KINDERIV_PYTHON_SCRIPT} ${CMAKE_BINARY_DIR}/share/coreneuron/kinderiv.py COPYONLY)
-configure_file(${DIMPLIC_CODE_FILE} ${CMAKE_BINARY_DIR}/share/coreneuron/dimplic.cpp COPYONLY)
-configure_file(${ENGINEMECH_CODE_FILE} ${CMAKE_BINARY_DIR}/share/coreneuron/enginemech.cpp COPYONLY)
-
 # Make headers avail to build tree
 configure_file(engine.h.in ${CMAKE_BINARY_DIR}/include/coreneuron/engine.h @ONLY)
 

coreneuron/CMakeLists.txt

@@ -60,9 +60,6 @@ void setup_nrnthreads_on_device(NrnThread* threads, int nthreads) {
 
         if (nt->n_vecplay) {
             /* copy VecPlayContinuous instances */
-
-            printf("\n Warning: VectorPlay used but NOT implemented on GPU! ");
-
             /** just empty containers */
             void** d_vecplay = (void**) acc_copyin(nt->_vecplay, sizeof(void*) * nt->n_vecplay);
             // note: we are using unified memory for NrnThread. Once VecPlay is copied to gpu,
@@ -337,9 +334,6 @@ void setup_nrnthreads_on_device(NrnThread* threads, int nthreads) {
 
         if (nt->n_vecplay) {
             /* copy VecPlayContinuous instances */
-
-            printf("\n Warning: VectorPlay used but NOT implemented on GPU! ");
-
             /** just empty containers */
             void** d_vecplay = (void**) acc_copyin(nt->_vecplay, sizeof(void*) * nt->n_vecplay);
             acc_memcpy_to_device(&(d_nt->_vecplay), &d_vecplay, sizeof(void**));

coreneuron/gpu/nrn_acc_manager.cpp

@@ -191,7 +191,7 @@ coremech_lib_target: $(corenrnmech_lib_target)
 	mkdir -p $(OUTPUT_DIR)/.libs; \
 	ln -s ../lib$(COREMECH_LIB_NAME)$(LIB_SUFFIX) $(OUTPUT_DIR)/.libs/lib$(COREMECH_LIB_NAME)$(LIB_SUFFIX)
 
-$(ENGINEMECH_OBJ): | $(MOD_OBJS_DIR)
+$(ENGINEMECH_OBJ): $(CORENRN_SHARE_CORENRN_DIR)/enginemech.cpp | $(MOD_OBJS_DIR)
 	$(CXX_COMPILE_CMD) -c -DADDITIONAL_MECHS $(CORENRN_SHARE_CORENRN_DIR)/enginemech.cpp -o $(ENGINEMECH_OBJ)
 
 # build shared library of mechanisms