dc_trace Module Reference

Debug tracing module. More...

Data Types
interface	datadump
interface	debug

Functions/Subroutines
integer function, public	sublevel ()
subroutine, public	dbg_scratch (on)
subroutine, public	setdebug (debug)
subroutine, public	beginsub (name, fmt, i, r, d, l, n, c1, c2, c3, ca, version)
subroutine, public	endsub (name, fmt, i, r, d, l, n, c1, c2, c3, ca)
subroutine, public	dbgmessage (fmt, i, r, d, l, n, c1, c2, c3, ca)

Variables
integer, save, public	dbg = -1

Detailed Description

Debug tracing module.

Author

Yasuhiro MORIKAWA, Eizi TOYODA

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. see COPYRIGHT in detail

Function/Subroutine Documentation

beginsub()

subroutine, public dc_trace::beginsub	(	character(*), intent(in)	name,
		character(*), intent(in), optional	fmt,
		integer, dimension(:), intent(in), optional	i,
		real, dimension(:), intent(in), optional	r,
		real(dp), dimension(:), intent(in), optional	d,
		logical, dimension(:), intent(in), optional	l,
		integer, dimension(:), intent(in), optional	n,
		character(*), intent(in), optional	c1,
		character(*), intent(in), optional	c2,
		character(*), intent(in), optional	c3,
		character(*), dimension(:), intent(in), optional	ca,
		character(*), intent(in), optional	version
	)

Output subprogram start message

Outputs the subprogram name given to name as follows:

# call name

By calling multiple times, messages are output showing the hierarchical structure (see dc_trace Overview). Make sure to call EndSub the same number of times as BeginSub.

Additional messages can be output by providing fmt and subsequent arguments:

# call name : fmt

See dc_string::CPrintf for format specification.

The version argument specifies the version number of the subprogram. The version string is displayed only on the first call of a subprogram.

Parameters

[in]	name	Subprogram name
[in]	fmt	Format string for additional message (optional)
[in]	i	Integer array for formatting
[in]	r	Real array for formatting
[in]	d	Double precision array for formatting
[in]	L	Logical array for formatting
[in]	n	Integer array for formatting
[in]	c1	Character string 1 for formatting
[in]	c2	Character string 2 for formatting
[in]	c3	Character string 3 for formatting
[in]	ca	Character array for formatting
[in]	version	Version number of the subprogram (optional)

Definition at line 474 of file dc_trace.f90.

    use dc_types, only: string, dp
    use dc_string, only: cprintf, strinclude
    character(*), intent(in)          :: name
    character(*), intent(in), optional:: fmt
    integer,      intent(in), optional:: i(:), n(:)
    real,         intent(in), optional:: r(:)
    real(DP),     intent(in), optional:: d(:)
    logical,      intent(in), optional:: L(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    character(*), intent(in), optional:: version
    character(STRING) :: cbuf
    character(STRING) :: name_ver
    logical :: dbg_mode, print_version
    integer :: alloc_size
  continue
    if ( dbg < 0 ) return
    if (lfirst) call initialize
    call debug( dbg_mode )
    if ( dbg_mode ) then
      name_ver = name
      print_version = .false.
      !---------------------------------
      !  Print Version check
      if (present(version)) then
        if (.not. allocated(called_subname)) then
          allocate(called_subname(1))
          called_subname(1) = name
          print_version = .true.
        else
          if (.not. strinclude(called_subname, trim(name))) then
            alloc_size = size(called_subname)
            allocate(called_subname_tmp(alloc_size))
            called_subname_tmp = called_subname
            deallocate(called_subname)
            allocate(called_subname(alloc_size + 1))
            called_subname(1:alloc_size) = called_subname_tmp
            deallocate(called_subname_tmp)
            called_subname(alloc_size + 1) = name
            print_version = .true.
          end if
        end if
        if (print_version) then
          name_ver = cprintf('%c version=<%c>', &
            & c1=trim(name), c2=trim(version))
        end if
      end if
      !---------------------------------
      !  Print Debug message
      if (present(fmt)) then
        cbuf = cprintf(fmt, i, r, d, l, n, c1, c2, c3, ca)
        write(dbg, "(A, A, 'call ', A, ' : ', A)") trim(head), &
          & repeat(indent, level), trim(name_ver), trim(cbuf)
      else
        write(dbg, "(A, A, 'call ',A)") trim(head), &
          & repeat(indent, level), trim(name_ver)
      endif
    endif
    ! call errtra ! --- for Fujitsu debug
    if (level > size(table)) return
    level = level + 1
    table(level) = name

References dbg, dc_types::dp, and dc_types::string.

dbg_scratch()

subroutine, public dc_trace::dbg_scratch

(

logical, intent(in)

on

)

Erase debug messages

Operation has not been confirmed. Please use with caution.

By giving .true. to the logical variable on, subsequent debug messages can be erased.

By giving .false. to the logical variable on, messages since the previous Dbg_Scratch call will be output as debug messages again, and subsequent debug messages will also be output.

Parameters

[in]

on

If .true., erase subsequent debug messages. If .false., output erased messages and resume normal output.

Definition at line 237 of file dc_trace.f90.

    logical, intent(in):: on
    integer, save:: saved_dbg = -1
    logical:: x, p
    character(80):: line
    integer:: ios
  continue
    if (on) then
      if (dbg < 0) return
      saved_dbg = dbg
      ! 有効な 1 〜 99 の装置番号の内の大きめの値を設定 (?)
      dbg = 98
      do
        inquire(unit=dbg, exist=x, opened=p)
        ! 装置番号 dbg が接続可能で、かつ未接続の場合
        if (x .and. .not. p) then
          ! 装置番号 deg をスクラッチファイルとして開く。
          !   ※ スクラッチファイルとは、特殊な外部ファイルである。
          !      これは名前なしの一時ファイルであり、開いている
          !      間だけ存在する。つまり、プログラムが終了すると
          !      存在しなくなる。
          open(unit=dbg, status='SCRATCH')
          ! 開く事が出来ればそれで終了。
          return
        endif
        ! 装置番号 dbg が利用不可、または利用済の場合は 0 以下に
        ! なるまで dbg - 1 して繰り返す。
        dbg = dbg - 1
        if (dbg < 0) exit
      enddo
      ! 装置番号 dbg が開けない場合、dbg と saved_dbg を初期化
      dbg = saved_dbg
      saved_dbg = -1
    else
      ! 以前に装置番号 dbg = 98〜0 でスクラッチファイルを開けてい
      ! なければそれで終了
      if (saved_dbg < 0) return
      ! 装置番号 dbg に接続されたスクラッチファイルをその開始位置
      ! に位置付ける。エラーが生じたら「100 continue」へ
      rewind(dbg, err=100)
      do
        ! 装置番号 dbg に接続されたスクラッチファイルの一行を
        ! line へ
        read(dbg, '(A)', iostat=ios) line
        if (ios /= 0) exit
        ! line を装置番号 saved_dbg へ書き出す。
        write(saved_dbg, '(A)', iostat=ios) trim(line)
        if (ios /= 0) exit
      enddo
  100 continue
      close(dbg, iostat=ios)
      ! 最後に dbg と saved_dbg を初期化
      dbg = saved_dbg
      saved_dbg = -1
    endif

References dbg.

dbgmessage()

subroutine, public dc_trace::dbgmessage	(	character(*), intent(in)	fmt,
		integer, dimension(:), intent(in), optional	i,
		real, dimension(:), intent(in), optional	r,
		real(dp), dimension(:), intent(in), optional	d,
		logical, dimension(:), intent(in), optional	l,
		integer, dimension(:), intent(in), optional	n,
		character(*), intent(in), optional	c1,
		character(*), intent(in), optional	c2,
		character(*), intent(in), optional	c3,
		character(*), dimension(:), intent(in), optional	ca
	)

Output debug message

Outputs debug messages according to the format string fmt. See dc_string::CPrintf for format specification.

See dc_trace Example for usage examples.

Note

This subroutine does not change the internal variable level.

Parameters

[in]	fmt	Format string
[in]	i	Integer array for formatting
[in]	r	Real array for formatting
[in]	d	Double precision array for formatting
[in]	L	Logical array for formatting
[in]	n	Integer array for formatting
[in]	c1	Character string 1 for formatting
[in]	c2	Character string 2 for formatting
[in]	c3	Character string 3 for formatting
[in]	ca	Character array for formatting

Definition at line 679 of file dc_trace.f90.

    use dc_types, only: string, dp
    use dc_string, only: cprintf, tochar
    character(*), intent(in)          :: fmt
    integer,      intent(in), optional:: i(:), n(:)
    real,         intent(in), optional:: r(:)
    real(DP),     intent(in), optional:: d(:)
    logical,      intent(in), optional:: L(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    character(STRING):: cbuf
    character(STRING):: meshead_tmp
    integer          :: meshead_len
  continue
    if ( dbg < 0 ) return
    cbuf = cprintf(fmt, i, r, d, l, n, c1, c2, c3, ca)
    if (level < 1) then
      meshead_tmp = ''
      meshead_len = 0
    else
      meshead_tmp = meshead
      meshead_len = len(meshead)
    endif
    write(dbg, "(A, A, A, A)") &
      & trim(head), repeat( indent, max(level-1, 0) ), &
      & meshead_tmp(1:meshead_len), trim(cbuf)

References dbg, dc_types::dp, and dc_types::string.

endsub()

subroutine, public dc_trace::endsub	(	character(*), intent(in)	name,
		character(*), intent(in), optional	fmt,
		integer, dimension(:), intent(in), optional	i,
		real, dimension(:), intent(in), optional	r,
		real(dp), dimension(:), intent(in), optional	d,
		logical, dimension(:), intent(in), optional	l,
		integer, dimension(:), intent(in), optional	n,
		character(*), intent(in), optional	c1,
		character(*), intent(in), optional	c2,
		character(*), intent(in), optional	c3,
		character(*), dimension(:), intent(in), optional	ca
	)

Output subprogram end message

Outputs the subprogram name given to name as follows:

# end name

This corresponds one-to-one with BeginSub, so give the same name as the corresponding BeginSub argument.

Additional messages can be output by providing fmt and subsequent arguments:

# end name fmt

See dc_string::CPrintf for format specification.

Parameters

[in]	name	Subprogram name
[in]	fmt	Format string for additional message (optional)
[in]	i	Integer array for formatting
[in]	r	Real array for formatting
[in]	d	Double precision array for formatting
[in]	L	Logical array for formatting
[in]	n	Integer array for formatting
[in]	c1	Character string 1 for formatting
[in]	c2	Character string 2 for formatting
[in]	c3	Character string 3 for formatting
[in]	ca	Character array for formatting

Definition at line 598 of file dc_trace.f90.

    use dc_types, only: dp
    use dc_string, only: cprintf
    character(*), intent(in)          :: name
    character(*), intent(in), optional:: fmt
    integer,      intent(in), optional:: i(:), n(:)
    real,         intent(in), optional:: r(:)
    real(DP),     intent(in), optional:: d(:)
    logical,      intent(in), optional:: L(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    character(STRING):: cbuf
    logical:: debug_mode
  continue
    if ( dbg < 0 ) return
    if (lfirst) call initialize
    ! call errtra ! --- for Fujitsu debug
    if (level <= 0) then
      write(*, "(A, 'Warning EndSub[',A,'] without BeginSub')") &
        & trim(head), trim(name)
    else if (name /= table(level)) then
      write(*, "(A, 'Warning EndSub[',A,'] but tos[',A,']')") &
        & trim(head), trim(name), trim(table(level))
    else
      level = level - 1
    endif
    call debug( debug_mode )
    if ( debug_mode ) then
      if (present(fmt)) then
        cbuf = cprintf(fmt, i, r, d, l, n, c1, c2, c3, ca)
        write(dbg, "(A, A, 'end ', A, ' : ', A)") trim(head), &
          & repeat(indent, level), trim(name), trim(cbuf)
      else
        write(dbg, "(A, A, 'end ', A)") trim(head), &
          & repeat(indent, level), trim(name)
      endif
    endif

References dbg, and dc_types::dp.

setdebug()

subroutine, public dc_trace::setdebug

(

integer, intent(in), optional

debug

)

Turn debug mode on/off

Call this subroutine when you want to output debug messages.

If the integer variable debug is given, debug messages from subsequent subroutines will be output to that unit number. If debug is not given, debug messages will be output to unit number 0 (standard error output). If output to unit number 0 fails, debug messages will be output to unit number 6 (standard output) instead.

If a negative integer is given to debug, debug mode is disabled and no debug messages will be output.

When SetDebug is called, the following message is displayed:

#SetDebug: dbg = debug

Parameters

[in]

debug

Unit number for debug message output (optional). If not given, standard error output is used. If negative, debug mode is disabled.

Definition at line 339 of file dc_trace.f90.

    use dc_types, only: stdout, stderr
    implicit none
    integer, intent(in), optional:: debug
    integer:: ios
    logical:: initflag_mpi
    character(4):: myrank_str_mpi
    integer:: myrank_mpi, err_mpi
  continue
    call mpi_initialized(initflag_mpi, err_mpi)
    if ( initflag_mpi ) then
      call mpi_comm_rank(mpi_comm_world, myrank_mpi, err_mpi)
      if ( myrank_mpi > 9999 ) then
        head = '#rOVER#'
      else
      write(unit=myrank_str_mpi, fmt="(i4.4)") myrank_mpi
      head = '#r' // myrank_str_mpi // '#'
      end if
    else
      head = '#'
    end if
    if (present(debug)) then
      ! debug が与えられる時は装置番号として deg を用いる。
      dbg = debug
      write(dbg, "(A, 'SetDebug: dbg =', i4)", iostat=ios) &
        & trim(head), dbg
      if (ios == 0) return
    else
      ! debug が与えられ無い時は装置番号 0 (標準エラー出力)
      dbg = stderr
      write(dbg, "(A, 'SetDebug: dbg = ', I0)", iostat=ios) trim(head), dbg
      if (ios == 0) return
      ! 装置番号 0 への出力が失敗したら装置番号 6 (標準出力)
      dbg = stdout
      write(dbg, "(A, 'SetDebug: dbg = ', I0)", iostat=ios) trim(head), dbg
      if (ios == 0) return
    endif
    ! 例外処理として dbg の初期化
    dbg = -1

References dbg, dc_types::stderr, and dc_types::stdout.

sublevel()

integer function, public dc_trace::sublevel

Return the hierarchical level of subprograms

Returns the hierarchical level of subprograms. The default level is 0. The level increases by 1 with BeginSub and decreases by 1 with EndSub.

Returns

Hierarchical level of subprograms

Definition at line 202 of file dc_trace.f90.

    result = level

Variable Documentation

dbg

integer, save, public dc_trace::dbg = -1

Definition at line 160 of file dc_trace.f90.

  integer, save, public :: dbg = -1     ! SetDebug で設定された