Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set truncation file handle check from < 0 to == -1 #739

Merged
merged 1 commit into from
Nov 1, 2024

Conversation

marshallward
Copy link
Member

This patch replaces the CS%[uv]_file < 0 checks with CS%[uv]_file == -1. FMS1 returns negative file handles for missing or otherwise error-prone files, but the FMS2 IO framework relies on newunit= to autogenerate handle IDs, which are always negative and cannot be used with checks for negative values.

The check is replaced with equality with -1. newunit is guaranteed to never return -1 for a valid file, so this is a valid check for a missing file. It also lets us continue to use -1 as the initial (unopened) value.

Behavior is compatible with mpp_open() output, so this can also be used with the FMS1 API.

A better solution would be to introduce some validation function which is defined by each API, but there is not yet any need for such sophistication.

This patch replaces the `CS%[uv]_file < 0` checks with
`CS%[uv]_file == -1`.  FMS1 returns negative file handles for missing or
otherwise error-prone files, but the FMS2 IO framework relies on
`newunit=` to autogenerate handle IDs, which are always negative and
cannot be used with checks for negative values.

The check is replaced with equality with -1.  `newunit` is guaranteed to
never return -1 for a valid file, so this is a valid check for a missing
file.  It also lets us continue to use -1 as the initial (unopened)
value.

Behavior is compatible with `mpp_open()` output, so this can also be
used with the FMS1 API.

A better solution would be to introduce some validation function which
is defined by each API, but there is not yet any need for such
sophistication.
@adcroft
Copy link
Member

adcroft commented Nov 1, 2024

@adcroft adcroft merged commit 96a91f5 into NOAA-GFDL:dev/gfdl Nov 1, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants