Skip to content

Commit

Permalink
Implement try-fail method to write new attributes to NetCDF files in PIO
Browse files Browse the repository at this point in the history 
- Adds support for adding new attributes to existing NetCDF files by
  minimizing expensive mode switches between data and define modes.
- Introduces `put_att_pio` interface with try-fail logic, handling scalar
  and 1D attributes of various data types (int, real, double, string).
- Enhances performance by avoiding unnecessary transitions and includes
  extensive logging for better traceability.
- Ensures backward compatibility for NetCDF files generated by earlier MPAS
  versions.
  • Loading branch information
@amstokely
amstokely committed Sep 17, 2024
1 parent 2cc8060 commit 7b75c62
Showing 1 changed file with 167 additions and 45 deletions.
212 changes: 167 additions & 45 deletions src/framework/mpas_io.F
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ module mpas_io

#ifdef MPAS_PIO_SUPPORT
integer, private :: io_global_err = PIO_noerr
interface put_att_pio
module procedure put_att_0d_generic_pio
module procedure put_att_1d_generic_pio
end interface put_att_pio
#endif
#ifdef MPAS_SMIOL_SUPPORT
integer, private :: io_global_err = SMIOL_SUCCESS
Expand Down Expand Up @@ -5033,6 +5037,149 @@ subroutine MPAS_io_get_att_real1d(handle, attName, attValue, fieldname, precisio

end subroutine MPAS_io_get_att_real1d

function handle_put_att_pio_redef(handle) result (pio_ierr)
implicit none
type(MPAS_IO_Handle_type), intent(inout) :: handle
integer :: pio_ierr

call mpas_log_write('Calling PIO_redef')
pio_ierr = PIO_redef(handle % pio_file)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if
call mpas_log_write('Successfully called PIO_redef')

end function handle_put_att_pio_redef

function handle_put_att_pio_enddef(handle) result (pio_ierr)
implicit none
type(MPAS_IO_Handle_type), intent(inout) :: handle
integer :: pio_ierr

call mpas_log_write('Calling PIO_enddef')
pio_ierr = PIO_enddef(handle % pio_file)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if
call mpas_log_write('Successfully called PIO_enddef')

end function handle_put_att_pio_enddef

function put_att_0d_generic_pio(handle, varid, attName, attValue, ierr) result(pio_ierr)
implicit none
type(MPAS_IO_Handle_type), intent(inout) :: handle
integer, intent(in) :: varid
character(len=*), intent(in) :: attName
class(*), intent(in) :: attValue
integer, optional :: ierr
integer :: pio_ierr
character(len=*), parameter :: log_message_prefix = 'Calling PIO_put_att for'

select type(attValue)
type is (integer)
call mpas_log_write(log_message_prefix//' integer attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R4KIND))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
call mpas_log_write(log_message_prefix//' real(kind=R4KIND) attribute '//trim(attname))
type is (real(kind=R8KIND))
call mpas_log_write(log_message_prefix//' real(kind=R8KIND) attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (character(len=*))
call mpas_log_write(log_message_prefix//' text attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
end select

if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND

if (handle % preexisting_file .and. .not. handle % data_mode) then
if (handle_put_att_pio_redef(handle) /= PIO_noerr) return

select type(attValue)
type is (integer)
call mpas_log_write('Calling PIO_put_att for integer attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R4KIND))
call mpas_log_write('Calling PIO_put_att for real(kind=R4KIND) attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R8KIND))
call mpas_log_write('Calling PIO_put_att for real(kind=R8KIND) attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (character(len=*))
call mpas_log_write('Calling PIO_put_att for text attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
end select

if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if

if (handle_put_att_pio_enddef(handle) /= PIO_noerr) return

if (present(ierr)) ierr = MPAS_IO_NOERR
end if
return
end if
end function put_att_0d_generic_pio

function put_att_1d_generic_pio(handle, varid, attName, attValue, ierr) result(pio_ierr)
implicit none
type(MPAS_IO_Handle_type), intent(inout) :: handle
integer, intent(in) :: varid
character(len=*), intent(in) :: attName
class(*), dimension(:), intent(in) :: attValue
integer, optional :: ierr
integer :: pio_ierr
character(len=*), parameter :: log_message_prefix = 'Calling PIO_put_att for'

select type(attValue)
type is (integer)
call mpas_log_write(log_message_prefix//' integer 1D-array attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R4KIND))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
call mpas_log_write(log_message_prefix//' real(kind=R4KIND) 1D-array attribute '//trim(attname))
type is (real(kind=R8KIND))
call mpas_log_write(log_message_prefix//' real(kind=R8KIND) 1D-array attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
end select

if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND

if (handle % preexisting_file .and. .not. handle % data_mode) then
if (handle_put_att_pio_redef(handle) /= PIO_noerr) return
select type(attValue)
type is (integer)
call mpas_log_write('Calling PIO_put_att for integer 1D-array attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R4KIND))
call mpas_log_write('Calling PIO_put_att for real(kind=R4KIND) 1D-array attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
type is (real(kind=R8KIND))
call mpas_log_write('Calling PIO_put_att for real(kind=R8KIND) 1D-array attribute '//trim(attname))
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValue)
end select

if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if

if (handle_put_att_pio_enddef(handle) /= PIO_noerr) return
if (present(ierr)) ierr = MPAS_IO_NOERR
end if
return
end if
end function put_att_1d_generic_pio



subroutine MPAS_io_get_att_text(handle, attName, attValue, fieldname, ierr)

Expand Down Expand Up @@ -5338,7 +5485,7 @@ subroutine MPAS_io_put_att_int0d(handle, attName, attValue, fieldname, syncVal,
end if

#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValueLocal)
pio_ierr = put_att_pio(handle, varid, attName, attValueLocal, ierr=ierr)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND
Expand Down Expand Up @@ -5523,7 +5670,7 @@ subroutine MPAS_io_put_att_int1d(handle, attName, attValue, fieldname, syncVal,
end if

#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValueLocal)
pio_ierr = put_att_pio(handle, varid, attName, attValueLocal, ierr=ierr)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND
Expand Down Expand Up @@ -5689,7 +5836,7 @@ subroutine MPAS_io_put_att_real0d(handle, attName, attValue, fieldname, syncVal,
(MPAS_IO_NATIVE_PRECISION /= MPAS_IO_SINGLE_PRECISION)) then
singleVal = real(attValueLocal,R4KIND)
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, singleVal)
pio_ierr = put_att_pio(handle, varid, attName, singleVal, ierr=ierr)
#endif

#ifdef MPAS_SMIOL_SUPPORT
Expand All @@ -5703,7 +5850,7 @@ subroutine MPAS_io_put_att_real0d(handle, attName, attValue, fieldname, syncVal,
(MPAS_IO_NATIVE_PRECISION /= MPAS_IO_DOUBLE_PRECISION)) then
doubleVal = real(attValueLocal,R8KIND)
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, doubleVal)
pio_ierr = put_att_pio(handle, varid, attName, doubleVal, ierr=ierr)
#endif

#ifdef MPAS_SMIOL_SUPPORT
Expand All @@ -5715,7 +5862,7 @@ subroutine MPAS_io_put_att_real0d(handle, attName, attValue, fieldname, syncVal,
#endif
else
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValueLocal)
pio_ierr = put_att_pio(handle, varid, attName, attValueLocal, ierr=ierr)
#endif

#ifdef MPAS_SMIOL_SUPPORT
Expand All @@ -5733,6 +5880,14 @@ subroutine MPAS_io_put_att_real0d(handle, attName, attValue, fieldname, syncVal,
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND
return
end if

! if (handle % preexisting_file) then
! pio_ierr = PIO_enddef(handle % pio_file)
! if (pio_ierr /= PIO_noerr) then
! io_global_err = pio_ierr
! return
! end if
! end if
#endif
#ifdef MPAS_SMIOL_SUPPORT
if (local_ierr /= SMIOL_SUCCESS) then
Expand Down Expand Up @@ -5919,20 +6074,20 @@ subroutine MPAS_io_put_att_real1d(handle, attName, attValue, fieldname, syncVal,
allocate(singleVal(size(attValueLocal)))
singleVal(:) = real(attValueLocal(:),R4KIND)
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, singleVal)
pio_ierr = put_att_pio(handle, varid, attName, singleVal, ierr=ierr)
#endif
deallocate(singleVal)
else if ((new_attlist_node % attHandle % precision == MPAS_IO_DOUBLE_PRECISION) .and. &
(MPAS_IO_NATIVE_PRECISION /= MPAS_IO_DOUBLE_PRECISION)) then
allocate(doubleVal(size(attValueLocal)))
doubleVal(:) = real(attValueLocal(:),R8KIND)
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, doubleVal)
pio_ierr = put_att_pio(handle, varid, attName, doubleVal, ierr=ierr)
#endif
deallocate(doubleVal)
else
#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, attValueLocal)
pio_ierr = put_att_pio(handle, varid, attName, attValueLocal, ierr=ierr)
#endif
end if
#ifdef MPAS_PIO_SUPPORT
Expand All @@ -5950,6 +6105,9 @@ subroutine MPAS_io_put_att_real1d(handle, attName, attValue, fieldname, syncVal,
end subroutine MPAS_io_put_att_real1d





subroutine MPAS_io_put_att_text(handle, attName, attValue, fieldname, syncVal, ierr)

implicit none
Expand Down Expand Up @@ -6100,43 +6258,7 @@ subroutine MPAS_io_put_att_text(handle, attName, attValue, fieldname, syncVal, i
end if

#ifdef MPAS_PIO_SUPPORT
pio_ierr = PIO_put_att(handle % pio_file, varid, attName, trim(attValueLocal))
if (pio_ierr /= PIO_noerr) then

io_global_err = pio_ierr
if (present(ierr)) ierr = MPAS_IO_ERR_BACKEND

!
! If we are working with a pre-existing file and the text attribute is larger than in the file, we need
! to enter define mode before writing the attribute. Note the PIO_redef documentation:
! 'Entering and leaving netcdf define mode causes a file sync operation to occur,
! these operations can be very expensive in parallel systems.'
!
if (handle % preexisting_file .and. .not. handle % data_mode) then
pio_ierr = PIO_redef(handle % pio_file)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if

pio_ierr = PIO_put_att(handle % pio_file, varid, attName, trim(attValueLocal))
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if

pio_ierr = PIO_enddef(handle % pio_file)
if (pio_ierr /= PIO_noerr) then
io_global_err = pio_ierr
return
end if

if (present(ierr)) ierr = MPAS_IO_NOERR

end if

return
end if
pio_ierr = put_att_pio(handle, varid, attName, attValueLocal, ierr=ierr)
#endif

#ifdef MPAS_SMIOL_SUPPORT
Expand Down

0 comments on commit 7b75c62

Please sign in to comment.