Implement workaround for LLVM runtime error when deallocate() is called on pointer member inside ESMF objects returned from C++.

Author: theurich

src/Infrastructure/Field/interface/ESMF_Field_C.F90

@@ -736,27 +736,30 @@ subroutine f_esmf_fieldcollectgarbage(field, rc)
 
     type(ESMF_Field)      :: field
     integer, intent(out)  :: rc
-  
+
+    type(ESMF_FieldType), pointer :: ftypepp
     integer :: localrc
-  
+
     ! initialize return code; assume routine not implemented
     localrc = ESMF_RC_NOT_IMPL
     rc = ESMF_RC_NOT_IMPL
-  
+
     !print *, "collecting Field garbage"
 
-    if (associated(field%ftypep)) then
+    ftypepp => field%ftypep ! LLVM workaround for deallocate() runtime error!
+
+    if (associated(ftypepp)) then
       ! destruct internal data allocations
-      call ESMF_FieldDestruct(field%ftypep, rc=localrc)
+      call ESMF_FieldDestruct(ftypepp, rc=localrc)
       if (ESMF_LogFoundError(localrc, &
         ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return
       ! deallocate actual FieldType allocation
-      !print *, "deallocate(field%ftypep)"
-      deallocate(field%ftypep, stat=localrc)
+      deallocate(ftypepp, stat=localrc)
       if (ESMF_LogFoundDeallocError(localrc, msg="Deallocating Field", &
         ESMF_CONTEXT, rcToReturn=rc)) return
     endif
+
     nullify(field%ftypep)
 
     ! return successfully

src/Infrastructure/FieldBundle/interface/ESMF_FieldBundle_C.F90

@@ -78,28 +78,32 @@ subroutine f_esmf_fbundlecollectgarbage(fb, rc)
 
     type(ESMF_FieldBundle):: fb
     integer, intent(out)  :: rc
-  
+
+    type(ESMF_FieldBundleType), pointer :: fbpp
     integer :: localrc
-  
+
     ! initialize return code; assume routine not implemented
     localrc = ESMF_RC_NOT_IMPL
     rc = ESMF_RC_NOT_IMPL
 
     !print *, "collecting FieldBundle garbage"
-  
-    if (associated(fb%this)) then
+
+    fbpp => fb%this ! LLVM workaround for deallocate() runtime error!
+
+    if (associated(fbpp)) then
       ! destruct internal data allocations
-      call ESMF_FieldBundleDestruct(fb%this, localrc)
+      call ESMF_FieldBundleDestruct(fbpp, rc=localrc)
       if (ESMF_LogFoundError(localrc, &
         ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, &
         rcToReturn=rc)) return
       ! deallocate actual FieldBundleType allocation
-      deallocate(fb%this, stat=localrc)
+      deallocate(fbpp, stat=localrc)
       if (ESMF_LogFoundDeallocError(localrc, msg="Deallocating FieldBundle", &
         ESMF_CONTEXT, &
         rcToReturn=rc)) return
     endif
+
     nullify(fb%this)
 
     ! return successfully

src/Infrastructure/LocStream/interface/ESMF_LocStream_C.F90

@@ -195,28 +195,32 @@ subroutine f_esmf_locstreamcollectgarbage(locstream, rc)
     implicit none
 
     type(ESMF_LocStream) :: locstream
-    integer, intent(out) :: rc     
-  
-    integer :: localrc              
-  
+    integer, intent(out) :: rc
+
+    type(ESMF_LocStreamType), pointer :: lspp
+    integer :: localrc
+
     ! initialize return code; assume routine not implemented
     localrc = ESMF_RC_NOT_IMPL
     rc = ESMF_RC_NOT_IMPL
-  
+
     !print *, "collecting LocStream garbage"
-  
+
+    lspp => locstream%lstypep ! LLVM workaround for deallocate() runtime error!
+
     ! destruct internal data allocations
-    call ESMF_LocStreamDestruct(locstream%lstypep, rc=localrc)
+    call ESMF_LocStreamDestruct(lspp, rc=localrc)
     if (ESMF_LogFoundError(localrc, &
       ESMF_ERR_PASSTHRU, &
       ESMF_CONTEXT, rcToReturn=rc)) return
 
     ! deallocate actual LocStreamType allocation
-    if (associated(locstream%lstypep)) then
-      deallocate(locstream%lstypep, stat=localrc)
+    if (associated(lspp)) then
+      deallocate(lspp, stat=localrc)
       if (ESMF_LogFoundDeallocError(localrc, msg="Deallocating LocStream", &
         ESMF_CONTEXT, rcToReturn=rc)) return
     endif
+
     nullify(locstream%lstypep)
 
     ! return successfully

src/Infrastructure/XGridGeomBase/src/ESMF_XGridGeomBase.F90

@@ -1362,6 +1362,7 @@ subroutine f_esmf_xgridgeombasecolgarbage(gb, rc)
     type(ESMF_XGridGeomBase)  :: gb
     integer, intent(out) :: rc
 
+    type(ESMF_XGridGeomBaseClass), pointer :: gbcpp
     integer :: localrc
 
     ! initialize return code; assume routine not implemented
@@ -1370,12 +1371,15 @@ subroutine f_esmf_xgridgeombasecolgarbage(gb, rc)
 
     !print *, "collecting GeomBase garbage"
 
+    gbcpp => gb%gbcp  ! LLVM workaround for deallocate() runtime error!
+
     ! deallocate actual GeomBaseClass allocation
-    if (associated(gb%gbcp)) then
-      deallocate(gb%gbcp, stat=localrc)
+    if (associated(gbcpp)) then
+      deallocate(gbcpp, stat=localrc)
       if (ESMF_LogFoundAllocError(localrc, msg="Deallocating GeomBase", &
         ESMF_CONTEXT, rcToReturn=rc)) return
     endif
+
     nullify(gb%gbcp)
 
     ! return successfully

src/Superstructure/Component/interface/ESMF_Comp_C.F90

@@ -491,6 +491,7 @@ recursive subroutine f_esmf_compcollectgarbage2(comp, rc)
   type(ESMF_CWrap)     :: comp
   integer, intent(out) :: rc
 
+  type(ESMF_CompClass), pointer :: comppp
   integer :: localrc
   integer :: timeout
   logical :: timeoutFlag
@@ -501,22 +502,25 @@ recursive subroutine f_esmf_compcollectgarbage2(comp, rc)
 
   !print *, "collecting Component garbage #2"
 
+  comppp => comp%compp  ! LLVM workaround for deallocate() runtime error!
+
   ! destruct internal data allocations and perform full shut down, making this
   ! call collective on some MPI implementations
   timeout = 10  ! allow for 10s timeout
   ! calling with 'timeoutFlag' prevents timeout to propagate as error condition
-  call ESMF_CompDestruct(comp%compp, interCompComm=.false., &
+  call ESMF_CompDestruct(comppp, interCompComm=.false., &
     fullShutdown=.true., timeout=timeout, timeoutFlag=timeoutFlag, rc=localrc)
   if (ESMF_LogFoundError(localrc, &
     ESMF_ERR_PASSTHRU, &
     ESMF_CONTEXT, rcToReturn=rc)) return
 
   ! deallocate actual CompClass allocation
-  if (associated(comp%compp)) then
-    deallocate(comp%compp, stat=localrc)
+  if (associated(comppp)) then
+    deallocate(comppp, stat=localrc)
     if (ESMF_LogFoundDeallocError(localrc, msg="Deallocating Comp", &
       ESMF_CONTEXT, rcToReturn=rc)) return
   endif
+
   nullify(comp%compp)
 
   ! return successfully

src/Superstructure/State/interface/ESMF_State_C.F90

@@ -455,34 +455,38 @@ subroutine f_esmf_statecollectgarbage(state, rc)
     use ESMF_LogErrMod
     use ESMF_StateTypesMod
     use ESMF_StateMod
-    
+
     implicit none
-    
+
     type(ESMF_State)     :: state
     integer, intent(out) :: rc
-  
+
+    type(ESMF_StateClass), pointer :: statepp
     integer :: localrc
-  
+
     ! initialize return code; assume routine not implemented
     localrc = ESMF_RC_NOT_IMPL
     rc = ESMF_RC_NOT_IMPL
-  
+
     !print *, "collecting State garbage"
 
-    if (associated(state%statep)) then
+    statepp => state%statep ! LLVM workaround for deallocate() runtime error!
+
+    if (associated(statepp)) then
       ! destruct internal data allocations
-      call ESMF_StateDestruct(state%statep, rc=localrc)
+      call ESMF_StateDestruct(statepp, rc=localrc)
       if (ESMF_LogFoundError(localrc, &
         ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, &
         rcToReturn=rc)) return
       ! deallocate actual StateClass allocation
-      deallocate(state%statep, stat=localrc)
+      deallocate(statepp, stat=localrc)
       localrc = merge (ESMF_SUCCESS, ESMF_RC_MEM_DEALLOCATE, localrc == 0)
       if (ESMF_LogFoundDeallocError(localrc, msg="Deallocating State", &
         ESMF_CONTEXT, &
         rcToReturn=rc)) return
     endif
+
     nullify(state%statep)
 
     ! return successfully