profiler.F90

Go to the documentation of this file.

! Copyright (c) 2022-2024, The Neko Authors
! All rights reserved.
!
! Redistribution and use in source and binary forms, with or without
! modification, are permitted provided that the following conditions
! are met:
!
!   * Redistributions of source code must retain the above copyright
!     notice, this list of conditions and the following disclaimer.
!
!   * Redistributions in binary form must reproduce the above
!     copyright notice, this list of conditions and the following
!     disclaimer in the documentation and/or other materials provided
!     with the distribution.
!
!   * Neither the name of the authors nor the names of its
!     contributors may be used to endorse or promote products derived
!     from this software without specific prior written permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
! "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
! LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
! FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
! COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
! INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
! BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
! LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
! ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
! POSSIBILITY OF SUCH DAMAGE.
!
module profiler
  use neko_config, only : neko_bcknd_cuda
  use device, only : device_profiler_start, device_profiler_stop
  use nvtx
  use roctx
  use craypat
  use runtime_stats, only : neko_rt_stats
  use, intrinsic :: iso_c_binding
  !$ use omp_lib
  implicit none
  private
 
  public :: profiler_start, profiler_start_region, profiler_end_region, &
       profiler_stop
 
contains
 
  subroutine profiler_start
    if ((neko_bcknd_cuda .eq. 1)) then
#if defined(HAVE_NVTX)
       call device_profiler_start
#endif
    else
#ifdef CRAYPAT
       call craypat_record_start
#endif
    end if
  end subroutine profiler_start
 
  subroutine profiler_stop
    if ((neko_bcknd_cuda .eq. 1)) then
#if defined(HAVE_NVTX)
       call device_profiler_stop
#endif
    else
#ifdef CRAYPAT
       call craypat_record_stop
#endif
    end if
  end subroutine profiler_stop
 
  subroutine profiler_start_region(name, region_id)
    character(kind=c_char,len=*) :: name
    integer, optional :: region_id
    logical :: in_parallel
 
#ifdef HAVE_NVTX
    if (present(region_id)) then
       call nvtxstartrange(name, region_id)
    else
       call nvtxstartrange(name)
    end if
#elif HAVE_ROCTX
    call roctxstartrange(name)
#elif CRAYPAT
    if (present(region_id)) then
       call craypat_region_begin(name, region_id)
    end if
#endif
 
#if defined(__FUJITSU) && defined(NEKO_FJPROF)
    if (present(region_id)) then
       call fapp_start(trim(name), region_id, 0)
    end if
#endif
 
    ! Skip runtime stats inside OMP parallel regions: neko_rt_stats uses a
    ! single shared LIFO stack that is not thread-safe. Concurrent pushes from
    ! different threads corrupt the stack order and cause region mismatches.
    in_parallel = .false.
    !$ in_parallel = omp_in_parallel()
    if (.not. in_parallel) then
       call neko_rt_stats%start_region(name, region_id)
    end if
 
  end subroutine profiler_start_region
 
  subroutine profiler_end_region(name, region_id)
    character(kind=c_char, len=*), optional :: name
    integer, optional :: region_id
    logical :: in_parallel
 
#ifdef HAVE_NVTX
    call nvtxrangepop
#elif HAVE_ROCTX
    call roctxrangepop
#elif CRAYPAT
    if (present(region_id)) then
       call craypat_region_end(region_id)
    end if
#endif
 
#if defined(__FUJITSU) && defined(NEKO_FJPROF)
    if (present(name) .and. present(region_id)) then
       call fapp_stop(trim(name), region_id, 0)
    end if
#endif
 
    in_parallel = .false.
    !$ in_parallel = omp_in_parallel()
    if (.not. in_parallel) then
       call neko_rt_stats%end_region(name, region_id)
    end if
 
  end subroutine profiler_end_region
 
end module profiler