Rest of index v2 changes

src/getgb2.F90

@@ -145,11 +145,19 @@ subroutine getgb2l2(lugb, idxver, cindex, gfld, iret)
        type(gribfield) :: gfld
        integer, intent(out) :: iret
      end subroutine getgb2l2
+     subroutine getgb2r2(lugb, idxver, cindex, gfld, iret)
+       use grib_mod
+       implicit none
+       integer, intent(in) :: lugb, idxver
+       character(len=1), intent(in) :: cindex(*)
+       type(gribfield) :: gfld
+       integer, intent(out) :: iret
+     end subroutine getgb2r2
   end interface
 
   ! Determine whether index buffer needs to be initialized.
   irgi = 0
-  idxver = 1
+  idxver = 2
   call getidx2(lugb, lugi, idxver, cbuf, nlen, nnum, irgi)
   if (irgi .gt. 1) then
      iret = 96
@@ -170,7 +178,7 @@ end subroutine getgb2l2
 
   ! Read and unpack grib record.
   if (unpack) then
-     call getgb2r(lugb, cbuf(lpos), gfld, iret)
+     call getgb2r2(lugb, idxver, cbuf(lpos), gfld, iret)
   endif
   k = jk
 end subroutine getgb2

src/getgb2r.F90

@@ -1,18 +1,76 @@
 !> @file
-!> @brief Read and unpack sections 6 and 7 from a GRIB2 message.
+!> @brief Read and unpack sections 6 and 7 from a GRIB2 message using
+!> an index record.
 !> @author Stephen Gilbert @date 2002-01-11
 
-!> Read and unpack sections 6 and 7 from a GRIB2 message.
+!> Read and unpack sections 6 and 7 from a GRIB2 message using a
+!> version 1 index record.
 !>
-!> It assumes that the metadata for this field already exists in
-!> derived type @ref grib_mod::gribfield. Specifically, it requires
-!> gfld\%ibmap, gfld\%ngrdpts, gfld\%idrtnum, gfld\%idrtmpl, and
-!> gfld\%ndpts.
+!> This function is maintained for backward compatibility. New code
+!> should use getgb2r2(), which can handle both version 1 and version
+!> 2 index records.
 !>
-!> It decodes information for the selected grib field and returns it
-!> in a derived type variable, gfld, of type @ref
-!> grib_mod::gribfield. Users of this routine will need to include the
-!> line "use grib_mod" in their calling routine.
+!> Metadata for the field must already exists in derived type @ref
+!> grib_mod::gribfield. Specifically, it requires gfld\%ibmap,
+!> gfld\%ngrdpts, gfld\%idrtnum, gfld\%idrtmpl, and gfld\%ndpts.
+!>
+!> The field data is returned in derived type variable, gfld, of type
+!> @ref grib_mod::gribfield. Users of this routine will need to
+!> include the line "use grib_mod" in their calling routine.
+!>
+!> This subprogram is intended for private use by getgb2()
+!> routines only.
+!>
+!> Derived type gribfield contains pointers to many arrays of
+!> data. Users must free this memory by calling gf_free().
+!>
+!> @param[in] lugb integer unit of the unblocked grib data file.
+!> File must be opened with [baopen() or baopenr()]
+!> (https://noaa-emc.github.io/NCEPLIBS-bacio/) before calling
+!> this routine.
+!> @param[in] cindex version 1 index record of the field (see
+!> subroutine ix2gb2() for description of an index record.)
+!> @param[out] gfld derived type @ref grib_mod::gribfield.
+!> @param[out] iret Return code:
+!> - 0 all ok
+!> - 97 error reading grib file
+!> - other gf_getfld grib2 unpacker return code
+!>
+!> @author Stephen Gilbert, Ed Hartnett @date 2002-01-11
+subroutine getgb2r(lugb, cindex, gfld, iret)
+  use grib_mod
+  implicit none
+
+  integer, intent(in) :: lugb
+  character(len=1), intent(in) :: cindex(*)
+  type(gribfield) :: gfld
+  integer, intent(out) :: iret
+
+  interface
+     subroutine getgb2r2(lugb, idxver, cindex, gfld, iret)
+       use grib_mod
+       implicit none
+       integer, intent(in) :: lugb, idxver
+       character(len=1), intent(in) :: cindex(*)
+       type(gribfield) :: gfld
+       integer, intent(out) :: iret
+     end subroutine getgb2r2
+  end interface
+
+  call getgb2r2(lugb, 1, cindex, gfld, iret)
+
+end subroutine getgb2r
+
+!> Read and unpack sections 6 and 7 from a GRIB2 message using a
+!> version 1 or version 2 index record.
+!>
+!> Metadata for the field must already exists in derived type @ref
+!> grib_mod::gribfield. Specifically, it requires gfld\%ibmap,
+!> gfld\%ngrdpts, gfld\%idrtnum, gfld\%idrtmpl, and gfld\%ndpts.
+!>
+!> The field data is returned in derived type variable, gfld, of type
+!> @ref grib_mod::gribfield. Users of this routine will need to
+!> include the line "use grib_mod" in their calling routine.
 !>
 !> This subprogram is intended for private use by getgb2()
 !> routines only.
@@ -23,33 +81,39 @@
 !> @note Do not engage the same logical unit from more than one
 !> processor.
 !>
-!> @param[in] LUGB integer unit of the unblocked grib data file.
+!> @param[in] lugb integer unit of the unblocked grib data file.
 !> File must be opened with [baopen() or baopenr()]
 !> (https://noaa-emc.github.io/NCEPLIBS-bacio/) before calling
 !> this routine.
-!> @param[in] CINDEX index record of the grib field (see
-!> subroutine ixgb2() for description of an index record.)
-!> @param[out] GFLD derived type @ref grib_mod::gribfield.
-!> @param[out] IRET integer return code
+!> @param[in] idxver Index version, 1 for legacy, 2 if file may be >
+!> 2 GB.
+!> @param[in] cindex version 1 or 2 index record of the grib field
+!> (see subroutine ixgb2() for description of an index record.)
+!> @param[out] gfld derived type @ref grib_mod::gribfield.
+!> @param[out] iret Return code:
 !> - 0 all ok
 !> - 97 error reading grib file
 !> - other gf_getfld grib2 unpacker return code
 !>
-!> @author Stephen Gilbert @date 2002-01-11
-SUBROUTINE GETGB2R(LUGB, CINDEX, GFLD, IRET)
+!> @author Ed Hartnett, Stephen Gilbert @date Feb 14, 2024
+subroutine getgb2r2(lugb, idxver, cindex, gfld, iret)
   use grib_mod
   implicit none
 
-  INTEGER, INTENT(IN) :: LUGB
-  CHARACTER(LEN=1), INTENT(IN) :: CINDEX(*)
-  TYPE(GRIBFIELD) :: GFLD
-  INTEGER, INTENT(OUT) :: IRET
+  integer, intent(in) :: lugb, idxver
+  character(len=1), intent(in) :: cindex(*)
+  type(gribfield) :: gfld
+  integer, intent(out) :: iret
 
-  INTEGER :: LSKIP, SKIP6, SKIP7
-  CHARACTER(LEN=1):: CSIZE(4)
-  CHARACTER(LEN=1), ALLOCATABLE :: CTEMP(:)
+  integer :: lskip, skip6, skip7
+  character(len=1):: csize(4)
+  character(len=1), allocatable :: ctemp(:)
   real, pointer, dimension(:) :: newfld
   integer :: n, lread, j, iskip, iofst, ilen, ierr, idum
+  integer :: inc
+  integer (kind = 8) :: lskip8, lread8, ilen8, iskip8
+  integer :: INT1_BITS, INT2_BITS, INT4_BITS, INT8_BITS
+  parameter(INT1_BITS = 8, INT2_BITS = 16, INT4_BITS = 32, INT8_BITS = 64)
 
   interface
      subroutine gf_unpack6(cgrib, lcgrib, iofst, ngpts, ibmap, bmap, ierr)
@@ -72,63 +136,75 @@ end subroutine gf_unpack7
   end interface
 
   ! Get info.
-  NULLIFY(gfld%bmap, gfld%fld)
-  IRET = 0
-  CALL G2_GBYTEC(CINDEX, LSKIP, 4*8, 4*8)
-  CALL G2_GBYTEC(CINDEX, SKIP6, 24*8, 4*8)
-  CALL G2_GBYTEC(CINDEX, SKIP7, 28*8, 4*8)
+  nullify(gfld%bmap, gfld%fld)
+  iret = 0
+  inc = 0
+  if (idxver .eq. 1) then
+     call g2_gbytec(cindex, lskip, INT4_BITS, INT4_BITS)
+     lskip8 = lskip
+  else
+     inc = 4
+     call g2_gbytec8(cindex, lskip8, INT4_BITS, INT8_BITS)
+     lskip = int(lskip8, kind(4))
+  endif
+  call g2_gbytec(cindex, skip6, (24 + inc) * INT1_BITS, INT4_BITS)
+  call g2_gbytec(cindex, skip7, (28 + inc) * INT1_BITS, INT4_BITS)
 
   ! Read and unpack bit_map, if present.
-  IF (gfld%ibmap .eq. 0 .OR. gfld%ibmap .eq. 254) THEN
-     ISKIP = LSKIP + SKIP6
+  if (gfld%ibmap .eq. 0 .or. gfld%ibmap .eq. 254) then
+     iskip = lskip + skip6
+     iskip8 = lskip8 + skip6
 
-     ! Get length of section.
-     CALL BAREAD(LUGB, ISKIP, 4, LREAD, CSIZE)
-     CALL G2_GBYTEC(CSIZE, ILEN, 0, 32)
-     ALLOCATE(CTEMP(ILEN))
-
-     ! Read in section.
-     CALL BAREAD(LUGB, ISKIP, ILEN, LREAD, CTEMP)  
-     IF (ILEN .NE. LREAD) THEN
-        IRET = 97
-        DEALLOCATE(CTEMP)
-        RETURN
-     ENDIF
-     IOFST = 0
-     CALL GF_UNPACK6(CTEMP, ILEN, IOFST, gfld%ngrdpts, idum, gfld%bmap, ierr)
-     IF (IERR .NE. 0) THEN
-        IRET = 98
-        DEALLOCATE(CTEMP)
-        RETURN
-     ENDIF
-     DEALLOCATE(CTEMP)
-  ENDIF
+     ! get length of section.
+     call bareadl(lugb, iskip8, 4_8, lread8, csize)
+     call g2_gbytec(csize, ilen, 0, 32)
+     allocate(ctemp(ilen))
+     ilen8 = ilen
+
+     ! read in section.
+     call bareadl(lugb, iskip8, ilen8, lread8, ctemp)  
+     if (ilen8 .ne. lread8) then
+        iret = 97
+        deallocate(ctemp)
+        return
+     endif
+     iofst = 0
+     call gf_unpack6(ctemp, ilen, iofst, gfld%ngrdpts, idum, gfld%bmap, ierr)
+     if (ierr .ne. 0) then
+        iret = 98
+        deallocate(ctemp)
+        return
+     endif
+     deallocate(ctemp)
+  endif
 
   ! Read and unpack data field.
-  ISKIP = LSKIP + SKIP7
+  iskip = lskip + skip7
+  iskip8 = lskip8 + skip7
 
   ! Get length of section.
-  CALL BAREAD(LUGB, ISKIP, 4, LREAD, CSIZE)    
-  CALL G2_GBYTEC(CSIZE, ILEN, 0, 32)
+  call bareadl(lugb, iskip8, 4_8, lread8, csize)    
+  call g2_gbytec(csize, ilen, 0, 32)
   if (ilen .lt. 6) ilen = 6
-  ALLOCATE(CTEMP(ILEN))
+  allocate(ctemp(ilen))
+  ilen8 = ilen
 
   ! Read in section.
-  CALL BAREAD(LUGB, ISKIP, ILEN, LREAD, CTEMP)  
-  IF (ILEN .NE. LREAD) THEN
-     IRET = 97
-     DEALLOCATE(CTEMP)
-     RETURN
-  ENDIF
-  IOFST = 0
-  CALL GF_UNPACK7(CTEMP, ILEN, IOFST, gfld%igdtnum, gfld%igdtmpl, &
+  call bareadl(lugb, iskip8, ilen8, lread8, ctemp)  
+  if (ilen8 .ne. lread8) then
+     iret = 97
+     deallocate(ctemp)
+     return
+  endif
+  iofst = 0
+  call gf_unpack7(ctemp, ilen, iofst, gfld%igdtnum, gfld%igdtmpl, &
        gfld%idrtnum, gfld%idrtmpl, gfld%ndpts, gfld%fld, ierr)
-  IF (IERR .NE. 0) THEN
-     IRET = 98
-     DEALLOCATE(CTEMP)
-     RETURN
-  ENDIF
-  DEALLOCATE(CTEMP)
+  if (ierr .ne. 0) then
+     iret = 98
+     deallocate(ctemp)
+     return
+  endif
+  deallocate(ctemp)
 
   ! If bitmap is used with this field, expand data field
   ! to grid, if possible.
@@ -149,4 +225,4 @@ end subroutine gf_unpack7
   else
      gfld%expanded = .true.
   endif
-END SUBROUTINE GETGB2R
+end subroutine getgb2r2