デバッグ時の追跡用モジュール 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

デバッグ時の追跡用モジュール

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
	)

副プログラム開始のメッセージ出力

文字型変数 name に与えた副プログラム名を以下のように出力します。

# call name

複数回呼ぶ事で階層構造が分かるメッセージが出力されます (dc_trace の Overview 参照)。必ず BeginSub と同様な数だけ EndSub を呼ぶようにしてください。

fmt およびそれ以降の引数を与える事で、付加メッセージも出力可能です:

# call name : fmt

書式は dc_string::CPrintf を参照して下さい。

version には副プログラムのバージョンナンバーを与えます。 version に与えられた文字列は、初回に呼び出された時のみ表示されます。

Note: このサブルーチンにより内部変数 level の値が 1 増えます。

Parameters

[in]	name	副プログラム名
[in]	fmt	付加メッセージ用フォーマット文字列 (省略可)
[in]	i	フォーマット用整数配列
[in]	r	フォーマット用実数配列
[in]	d	フォーマット用倍精度実数配列
[in]	L	フォーマット用論理配列
[in]	n	フォーマット用整数配列
[in]	c1	フォーマット用文字列1
[in]	c2	フォーマット用文字列2
[in]	c3	フォーマット用文字列3
[in]	ca	フォーマット用文字列配列
[in]	version	副プログラムのバージョンナンバー (省略可)

Definition at line 455 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 )

デバッグメッセージの抹消

動作未確認ですので利用の際にはご注意下さい。

論理型変数 on に .true. を与える事で、以降のデバッグメッセージを抹消する事が出来ます。

なお、論理型変数 on に .false. を与える事で、直前に呼んだ Dbg_Scratch 以降のメッセージをデバッグメッセージとして再び出力し、以降のデバッグメッセージも出力されるようにします。

Parameters

[in] on .true. の場合、以降のデバッグメッセージを抹消する。 .false. の場合、抹消されたメッセージを出力し、通常出力を再開する。

Definition at line 233 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
	)

デバッグ用メッセージ出力

フォーマット文字列 fmt に従ってデバッグメッセージを出力します。書式は dc_string::CPrintf を参照して下さい。

利用例に関しては dc_trace の Example を参照して下さい。

Note: このサブルーチンを用いても内部変数 level の値は変化しません。

Parameters

[in]	fmt	フォーマット文字列
[in]	i	フォーマット用整数配列
[in]	r	フォーマット用実数配列
[in]	d	フォーマット用倍精度実数配列
[in]	L	フォーマット用論理配列
[in]	n	フォーマット用整数配列
[in]	c1	フォーマット用文字列1
[in]	c2	フォーマット用文字列2
[in]	c3	フォーマット用文字列3
[in]	ca	フォーマット用文字列配列

Definition at line 660 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
	)

副プログラム終了のメッセージ出力

文字型変数 name に与えた副プログラム名を以下のように出力します。

# end name

BeginSub に対して一対一対応していますので、name には対応する BeginSub の引数 name と同じものを与えて下さい。

fmt およびそれ以降の引数を与える事で、付加メッセージも出力可能です:

# end name fmt

書式は dc_string::CPrintf を参照して下さい。

Note: このサブルーチンにより内部変数 level の値が 1 減ります。

Parameters

[in]	name	副プログラム名
[in]	fmt	付加メッセージ用フォーマット文字列 (省略可)
[in]	i	フォーマット用整数配列
[in]	r	フォーマット用実数配列
[in]	d	フォーマット用倍精度実数配列
[in]	L	フォーマット用論理配列
[in]	n	フォーマット用整数配列
[in]	c1	フォーマット用文字列1
[in]	c2	フォーマット用文字列2
[in]	c3	フォーマット用文字列3
[in]	ca	フォーマット用文字列配列

Definition at line 579 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 )

デバッグモードをオンオフ

デバッグメッセージを出力したい時にこのサブルーチンを呼びます。

整数型変数 debug が与えられる場合は、その装置番号 debug に、以降のサブルーチンによるデバッグメッセージを出力するようにします。 debug が与えられない場合、装置番号 0 (標準エラー出力) にデバッグメッセージが出力されるようになります。装置番号 0 への出力が成功しない場合は代わりに装置番号 6 (標準出力) にデバッグメッセージが出力されるようになります。

debug に負の整数を与える場合、デバッグモードが解除され、以降デバッグメッセージは出力されません。

なお、この SetDebug を呼んだ際にも、装置番号 debug に以下のメッセージが表示されます。

#SetDebug: dbg = debug

Parameters

[in] debug デバッグメッセージ出力用の装置番号 (省略可)。省略時は標準エラー出力を使用。負の値を与えるとデバッグモード解除。

Definition at line 335 of file dc_trace.f90.

    use dc_types, only: stdout, stderr
    implicit none
    integer, intent(in), optional:: debug
    integer:: ios
  continue
    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

副プログラムの階層レベルを返す

副プログラムの階層レベルを返します。レベルのデフォルトは 0 で、 BeginSub によりレベルは 1 増え、EndSub によりレベルは 1 減ります。

Returns: 副プログラムの階層レベル

Definition at line 198 of file dc_trace.f90.

199 result = level

Variable Documentation

◆ dbg

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

Definition at line 156 of file dc_trace.f90.

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

Data Types

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ beginsub()

◆ dbg_scratch()

◆ dbgmessage()

◆ endsub()

◆ setdebug()

◆ sublevel()

Variable Documentation

◆ dbg