Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions src/framework/mpas_stream_manager.F
Original file line number Diff line number Diff line change
Expand Up @@ -563,10 +563,96 @@ subroutine MPAS_stream_mgr_validate_streams(manager, streamID, ierr)!{{{
#endif

end do

! Only check filename_template uniqueness when validating all streams
if (.not. present(streamID)) then
call MPAS_stream_mgr_check_filename_template(manager, ierr=err_local)
Comment thread
mgduda marked this conversation as resolved.
if (present(ierr)) ierr = err_local
end if

end subroutine MPAS_stream_mgr_validate_streams!}}}


!-----------------------------------------------------------------------
! routine MPAS_stream_mgr_check_filename_template
!
!> \brief Check for identical filename templates in active output streams.
!> \author Abishek Gopal
!> \date June 3 2026
!> \details
!> Checks that there are no identical filename templates among active output
!> streams in the stream manager, which may lead to file conflicts. This
!> routine can be called from within MPAS_stream_mgr_validate_streams or
!> separately as needed.
!
!-----------------------------------------------------------------------
subroutine MPAS_stream_mgr_check_filename_template(manager, ierr)!{{{

implicit none

type (MPAS_streamManager_type), intent(inout) :: manager
integer, intent(out), optional :: ierr
Comment thread
mgduda marked this conversation as resolved.

integer :: threadNum
character (len=StrKIND) :: message, streamID
type (MPAS_stream_list_type), pointer :: stream1_cursor, stream2_cursor
logical :: stream1_pkg_active, stream2_pkg_active
logical :: stream1_output, stream2_output

STREAM_DEBUG_WRITE('-- Called MPAS_stream_mgr_check_filename_template() for all streams')

if (present(ierr)) ierr = MPAS_STREAM_MGR_NOERR

threadNum = mpas_threading_get_thread_num()

if ( threadNum == 0 ) then

streamID = '.*' ! query all streams

nullify(stream1_cursor)
do while (MPAS_stream_list_query(manager % streams, streamID, stream1_cursor))
Comment thread
mgduda marked this conversation as resolved.

stream1_pkg_active = stream_active_pkg_check(stream1_cursor)
stream1_output = (stream1_cursor % direction == MPAS_STREAM_OUTPUT) .or. &
(stream1_cursor % direction == MPAS_STREAM_INPUT_OUTPUT)

if (.not. stream1_cursor % active_stream .or. .not. stream1_output .or. .not. stream1_pkg_active) then
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking about it a bit more, perhaps we could also skip (for the purpose of finding duplicate filename_template values) streams whose input_interval or output_interval is none, since that stream -- although potentially active -- would never be read or written?

cycle
end if

nullify(stream2_cursor)
do while (MPAS_stream_list_query(manager % streams, streamID, stream2_cursor))

stream2_pkg_active = stream_active_pkg_check(stream2_cursor)
stream2_output = (stream2_cursor % direction == MPAS_STREAM_OUTPUT) .or. &
(stream2_cursor % direction == MPAS_STREAM_INPUT_OUTPUT)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I may be misreading the logic, but it looks like we will only catch cases where two output (or input-output) streams share a filename_template. However, I think we would also want to catch cases where an active input stream shares a filename_template with an active output (or input-output) stream.


! uniqueness_check has already checked that two different streams do not have the same name
if (trim(stream1_cursor % name) == trim(stream2_cursor % name) &
.or. .not. stream2_cursor % active_stream &
.or. .not. stream2_output &
.or. .not. stream2_pkg_active) then
cycle
end if

if (trim(stream1_cursor % filename_template) == trim(stream2_cursor % filename_template)) then
message = 'Found identical values of the filename_template attribute for multiple active output streams, ' &
// trim(stream1_cursor % name) // ' and ' // trim(stream2_cursor % name) // &
', in streams.<CORE>. This may result in file conflicts.'
call mpas_log_write(message, messageType=MPAS_LOG_ERR)
if (present(ierr)) ierr = MPAS_STREAM_MGR_ERROR
return
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than returning on the first pair of matching filename_template values, we could instead report all errors before returning. Admittedly, it may not be common for someone to define more than two streams that share a filename_template (or more than one pair of streams that conflict), but I think it's a small enough change to report all errors before returning that it's worth doing.

end if

end do

end do

end if

end subroutine MPAS_stream_mgr_check_filename_template!}}}


!-----------------------------------------------------------------------
! routine MPAS_stream_mgr_destroy_stream
!
Expand Down
7 changes: 0 additions & 7 deletions src/framework/xml_stream_parser.c
Original file line number Diff line number Diff line change
Expand Up @@ -486,13 +486,6 @@ int uniqueness_check(ezxml_t stream1, ezxml_t stream2)
fmt_err(msgbuf);
return 1;
}
if (strstr(type, "output") != NULL || strstr(type2, "output") != NULL){
if (strcmp(filename, filename2) == 0) {
snprintf(msgbuf, MSGSIZE, "Output streams \"%s\" and \"%s\" cannot share the filename_template \"%s\".", name, name2, filename);
fmt_err(msgbuf);
return 1;
}
}
}

return 0;
Expand Down