source: rubycfg_ssp/task.trb@ 283

# -*- coding: utf-8 -*-
#
#   TOPPERS/SSP Kernel
#       Toyohashi Open Platform for Embedded Real-Time Systems/
#       Advanced Standard Profile Kernel
# 
#   Copyright (C) 2015 by FUJI SOFT INCORPORATED, JAPAN
#   Copyright (C) 2015,2016 by Embedded and Real-Time Systems Laboratory
#               Graduate School of Information Science, Nagoya Univ., JAPAN
#   Copyright (C) 2017 by Naoki Saito
#              Nagoya Municipal Industrial Research Institute, JAPAN
# 
#   上記著作権者
は，以下の(1)〜(4)ã®æ¡ä»¶ã‚’æº€ãŸã™å ´åˆã«é™ã‚Šï¼Œæœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§
#   ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
#   変・再é…
å¸ƒï¼ˆä»¥ä¸‹ï¼Œåˆ©ç”¨ã¨å‘¼ã¶ï¼‰ã™ã‚‹ã“とを無償で許諾する．
#   (1) æœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚’ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã®å½¢ã§åˆ©ç”¨ã™ã‚‹å ´åˆã«ã¯ï¼Œä¸Šè¨˜ã®è‘—ä½œ
#       権表示，この利用条件および下記の無保証規定が，そのままの形でソー
#       スコード中に含まれていること．
#   (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
#       用できる形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œå†é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨
#       者
マニュアルなど）に，上記の著作権表示，この利用条件および下記
#       の無保証規定を掲載すること．
#   (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
#       用できない形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œæ¬¡ã®ã„ずれかの条件を満たすこ
#       と．
#     (a) 再é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨è€…
マニュアルなど）に，上記の著
#         作権表示，この利用条件および下記の無保証規定を掲載すること．
#     (b) 再é…
å¸ƒã®å½¢æ…
‹ã‚’，別に定める方法によって，TOPPERSプロジェクトに
#         å ±å‘Šã™ã‚‹ã“ã¨ï¼Ž
#   (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
#       害からも，上記著作権者
およびTOPPERSプロジェクトをå…
è²¬ã™ã‚‹ã“と．
#       また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
#       由に基づく請求からも，上記著作権者
およびTOPPERSプロジェクトを
#       å…
è²¬ã™ã‚‹ã“と．
# 
#   本ソフトウェアは，無保証で提供されているものである．上記著作権者
お
#   よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
#   に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
#   アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
#   ã®è²¬ä»»ã‚’è² ã‚ãªã„ï¼Ž
# 
#   $Id: task.trb 668 2016-03-03 13:57:53Z ertl-hiro $
# 

#
#               タスク管理モジュールの生成スクリプト
#

class TaskObject < KernelObject
  def initialize()
    super("tsk", "task")
    @tsk_apri_list = []
    @tsk_epri_list = []
    @reallocate_atskpri = {}
    @reallocate_etskpri = {}
    @higher_pri_tsklist = {}
    @stacksize_of_tasks = {}
  end

  # オブジェクトのID番号のマクロ定義の生成
  def generateIdMacro()
    # タスクIDを起動優å…
ˆåº¦(atskpri)ã®é«˜ã„é †ã« reallocate_atskpri へ割り当てて定義を kernel_cfg.h へ出力

    ($cfgData[:CRE_TSK].sort_by {|e| e[1][:atskpri].val}).each.with_index(1) do |e, index|
      @tsk_apri_list.push(e[0])
      @reallocate_atskpri[e[0]] = index 
      $kernelCfgH.add("#define #{e[1][:tskid].str} #{index}")

      # DEF_EPR で定義されていないタスクの実行時優å…
ˆåº¦ã‚’起動優å…
ˆåº¦ã«è¨­å®šã™ã‚‹
      epri = $cfgData[:DEF_EPR].find {|i| i[1][:tskid].val == e[1][:tskid].val}
      if epri
        @tsk_epri_list.push(epri[1][:exepri].val)
      else
        @tsk_epri_list.push(e[1][:atskpri].val)
      end 
    end

    $kernelCfgH.add()
  end

  #
  #  指定したタスクに対するスタック使用量の最大を計算
  #    引数：tskid：タスクID(内
部表現．起動時優å…
ˆåº¦ã®å†…
部表現に等しい)
  #    返値：当該タスクに足しするスタック使用量の最大値．
  #          この値は，当該タスクの実行開始から終了までの間に
  #          そのタスクに対するプリエンプトを考æ…
®ã—てスタック使用量を
  #          è¨ˆç®—ã—ãŸå ´åˆã«ï¼Œå¯èƒ½æ€§ã®ã‚ã‚‹çµ„ã¿åˆã‚ã›ã®ä¸­ã§æœ€å¤§ã¨ãªã‚‹å€¤ã‚’è¿”ã™ï¼Ž
  #
  def calc_stksz(tskid, nest_level=1)
    higher_pri_maxstksz = 0
    calculated_stack_size = 0
    stksz = 0
    taskEntry = $cfgData[@api][tskid]

    $kernelCfgC.add(" * " + ("\t" * nest_level) + "Calculation Start (Task ID = #{taskEntry[:tskid].str}, StackSize = #{taskEntry[:stksz]})")

    if @stacksize_of_tasks[tskid]
      # è¨ˆç®—ãŒæ—¢ã«å®Œäº†ã—ã¦ã„ã‚‹å ´åˆï¼Œè¨ˆç®—ã‚’ã‚¹ã‚­ãƒƒãƒ—ã™ã‚‹
      $kernelCfgC.add(" * " + ("\t" * nest_level) + "SKIP(max_stksz[#{taskEntry[:tskid].str}] = #{@stacksize_of_tasks[tskid]})")
      stksz = @stacksize_of_tasks[tskid]
    else
      # å®Œäº†ã—ã¦ã„ãªã„å ´åˆ
      $kernelCfgC.append(" * " + ("\t" * nest_level) + "Task list with higher priority than #{taskEntry[:tskid].str} = ")
      @higher_pri_tsklist[tskid].each.with_index do |id, index|
        $kernelCfgC.append(",") if index > 0
        $kernelCfgC.append("(#{$cfgData[@api][id][:tskid].str})")
      end
      $kernelCfgC.add()

      # 変数の初期化
      higher_pri_maxstksz = 0

      # 当該タスクID の実行時優å…
ˆåº¦ã‚ˆã‚Šé«˜ã„起動優å…
ˆåº¦ã‚’æŒã¤ã‚¿ã‚¹ã‚¯ãŒå­˜åœ¨ã™ã‚‹å ´åˆ
      if @higher_pri_tsklist[tskid].size > 0
        # それぞれの高優å…
ˆåº¦ã‚¿ã‚¹ã‚¯ã«å¯¾ã—，スタック計算を実行する
        @higher_pri_tsklist[tskid].each do |id|
          calculated_stack_size = calc_stksz(id, nest_level+1)
          # 最もサイズが大きいものだけを覚えておく
          if higher_pri_maxstksz < calculated_stack_size
            higher_pri_maxstksz = calculated_stack_size
          end
        end
      end

      $kernelCfgC.add(" * " + ("\t" * nest_level) + "higher_pri_maxstksz[#{taskEntry[:tskid].str}] = #{higher_pri_maxstksz}")

      # 高優å…
ˆåº¦ã‚¿ã‚¹ã‚¯ã®ã‚¹ã‚¿ãƒƒã‚¯ä½¿ç”¨é‡ã«ï¼Œå½“è©²ã‚¿ã‚¹ã‚¯ã®ä½¿ç”¨é‡ã‚’åŠ 算する
      stksz = higher_pri_maxstksz + taskEntry[:stksz]

      # 当該タスクIDに対して計算済みであることを記録
      @stacksize_of_tasks[tskid] = stksz
      $kernelCfgC.add(" * " + ("\t" * nest_level) + "DONE(stksz[#{taskEntry[:tskid].str}] = #{stksz})")
    end

    # 見積もりの最大を返す
    return stksz
  end

  # 事前のチェック
  def prepare()

    $cfgData[@api].sort.each do |key, params|

      # tskatrが無効（E_RSATR）
      #（TA_ACT，TA_RSTR，TA_NULL，TARGET_TSKATRä»¥å¤–ã®ãƒ“ãƒƒãƒˆãŒã‚»ãƒƒãƒˆã•ã‚Œã¦ã„ã‚‹å ´åˆï¼‰
      if (params[:tskatr] & ~($TA_ACT|$TA_RSTR|$TARGET_TSKATR)) != 0
        error_illegal_id("E_RSATR", params, :tskatr, :tskid)
      end

      # (TMIN_TPRI <= atskpri && atskpri <= TMAX_TPRI)ã§ãªã„å ´åˆ
      if !($TMIN_TPRI <= params[:atskpri] && params[:atskpri] <= $TMAX_TPRI)
        error_illegal_id("E_PAR", params, :atskpri, :tskid)
      end

      # atskpri ãŒé‡è¤‡ã™ã‚‹å ´åˆ (E_PAR)
      @tsk_apri_list.each do |id|
        if (params[:tskid].val != id) && (params[:atskpri] == $cfgData[@api][id][:atskpri])
          error_illegal_id("E_PAR", params, :atskpri, :tskid)
        end
      end

      # 実行時優å…
ˆåº¦
      if $cfgData[:DEF_EPR][params[:tskid].val]
        # exepri は TMIN_TPRI 以上 かつ TMAX_TPRI 以下(E_PAR)
        exepri = $cfgData[:DEF_EPR][params[:tskid].val][:exepri]
        if $TMIN_TPRI > exepri || $TMAX_TPRI < exepri
          $defepr_success = false
          error_illegal_id("E_PAR", params, :exepri, :tskid)
        end

        # exepri は atskpri 以下の値をもつ(優å…
ˆåº¦ãŒé«˜ã„) (E_ILUSE)
        if exepri > params[:atskpri]
          $defepr_success = false
          error_illegal_id("E_ILUSE", params, :exepri, :tskid)
        end
      end

      # stkszがターゲット定義の最小値（TARGET_MIN_STKSZï¼Œæœªå®šç¾©ã®å ´åˆã¯1）
      # ã‚ˆã‚Šã‚‚å°ã•ã„å ´åˆ
      if params[:stksz] < $TARGET_MIN_STKSZ
        error_ercd("E_PAR", params, "stksz is too small.")
      end

      # スタックのå…
ˆé ­ç•ªåœ°(stk)
      # å…
¨ã¦ã®å‡¦ç†å˜ä½ã®ã‚¹ã‚¿ãƒƒã‚¯ã¯å…
±æœ‰ã•ã‚Œã‚‹ï¼Ž
      # そのため，スタックサイズに関するチェックは
      # å…
±æœ‰ã‚¹ã‚¿ãƒƒã‚¯è¨­å®šã®ã¨ã“ろでまとめて行う．
      if params[:stk] != "NULL"
        error_ercd("E_PAR", params, "stk must be NULL.")
      end
    end
  end

  # ãƒ‡ãƒ¼ã‚¿æ§‹é€ ã®ç”Ÿæˆ
  def generateData()

    # äº‹å‰æº–å‚™ï¼ˆã‚¨ãƒ©ãƒ¼ãƒã‚§ãƒƒã‚¯ï¼Œãƒ¡ãƒ¢ãƒªé ˜åŸŸã®ç”Ÿæˆï¼‰
    prepare()

    #
    # オブジェクト初期化ブロックの生成
    #
    init_rdypmap = 0

    # タスク属性(tskatr)
    $kernelCfgC.append("const ATR\t_kernel_tinib_tskatr[TNUM_TSKID] = {")
    @tsk_apri_list.each.with_index do |id, index|
      tskatr = $cfgData[@api][id][:tskatr]
      $kernelCfgC.append(",") if index > 0
      $kernelCfgC.append("(#{tskatr.str})")
      if tskatr & $TA_ACT != 0
        init_rdypmap = init_rdypmap + (1 << index)
      end
    end
    $kernelCfgC.add("};")

    $kernelCfgC.add("const uint_t\t_kernel_init_rdypmap = #{init_rdypmap}U;")

    # 拡張情
å ±(exinf)
    $kernelCfgC.append("const intptr_t\t_kernel_tinib_exinf[TNUM_TSKID] = {")
    @tsk_apri_list.each.with_index do |id, index|
      exinf = $cfgData[@api][id][:exinf]
      $kernelCfgC.append(",") if index > 0
      $kernelCfgC.append("(intptr_t)(#{exinf})")
    end
    $kernelCfgC.add("};")

    # 起動番地(task)
    $kernelCfgC.append("const TASK\t_kernel_tinib_task[TNUM_TSKID] = {")
    @tsk_apri_list.each.with_index do |id, index|
      task = $cfgData[@api][id][:task]
      $kernelCfgC.append(",") if index > 0 
      $kernelCfgC.append("(#{task})")
    end 
    $kernelCfgC.add("};")

    # 実行時優å…
ˆåº¦(etskpri)
    $kernelCfgC.append("const uint_t\t_kernel_tinib_epriority[TNUM_TSKID] = {")
    @tsk_apri_list.each.with_index do |id, index|
      begin
        epri = @tsk_epri_list[index]
        @tsk_apri_list.each do |id2|
          if epri <= $cfgData[@api][id2][:atskpri]
            $kernelCfgC.append(",") if index > 0
            $kernelCfgC.append("INT_PRIORITY(#{@reallocate_atskpri[id2]})")
            @reallocate_etskpri[id] = @reallocate_atskpri[id2]
            break
          end
        end
        raise "the exepri of #{$cfgData[@api][id][:tskid].str}  is invalid." if !@reallocate_etskpri[id]
      rescue => e
        error_exit(e.message + " Abort.")
      end
    end
    $kernelCfgC.add("};")

    #
    # 優å…
ˆåº¦å‰²ã‚Šå½“て結果を出力
    #
    $kernelCfgC.add("/*")
    $kernelCfgC.add(" * Configuration result of task priority:")
    @tsk_apri_list.each do |id|
      $kernelCfgC.append(" * \t#{$cfgData[@api][id][:tskid]}:\tIPRI = #{@reallocate_atskpri[id]}")
      $kernelCfgC.add(", EXEPRI = #{@reallocate_etskpri[id]}")
    end
    $kernelCfgC.add2(" */")

    #
    #  タスクの最大スタック使用量の計算
    #
    
    # æœ¨æ§‹é€ ã®ãƒ‡ãƒ¼ã‚¿ä½œæˆ
    $root_apri = []
    (@reallocate_atskpri.sort_by {|id| id[1]}).reverse_each do |id|
      # 各タスク毎に，その実行時優å…
ˆåº¦ã‚ˆã‚Šã‚‚高い起動時優å…
ˆåº¦ã‚’もつタスクのリストを作る
      # それはプリエンプトされる可能性のあるタスクのリストとなる．
      @higher_pri_tsklist[id[0]] = []
      (@reallocate_atskpri.sort_by {|id| id[1]}).reverse_each do |id2|
        if @reallocate_etskpri[id[0]] > id2[1]
          @higher_pri_tsklist[id[0]].push(id2[0])
        end
      end
    end

    # ãƒ—ãƒªã‚¨ãƒ³ãƒ—ãƒˆã™ã‚‹ãƒ»ã•ã‚Œã‚‹é–¢ä¿‚ã‚’ç¤ºã™æœ¨æ§‹é€ ã®æ ¹(root)となるタスクの探索
    #   対象タスク(id)の起動時優å…
ˆåº¦(reallocate_atskpri[id]より低い
    #   (値としては大きい)起動時優å…
ˆåº¦ã‚’もつタスクの higher_pri_tsklist に
    #   対象タスク(id)ãŒå«ã¾ã‚Œãªã‘ã‚Œã°ï¼Œæ ¹ã¨ãªã‚‹
    (@reallocate_atskpri.sort_by {|id| id[1]}).reverse_each do |id|
      $is_root = true
      (@reallocate_atskpri.sort_by {|id| id[1]}).reverse_each do |id2|
        if $is_root && (@reallocate_atskpri[id[0]] < @reallocate_atskpri[id2[0]])
          if @higher_pri_tsklist[id2[0]].index(id[0])
            $is_root = false
          end
        end
      end
      if $is_root
        $root_apri.push(id)
      end
    end

    #
    #  出力開始 
    #
    $kernelCfgC.add("/* \n * Task Stack Size Estimation:")

    # æ ¹ã¨ãªã‚‹ã‚¿ã‚¹ã‚¯ã«å¯¾ã—ï¼Œãã®æœ€å¤§ã‚¿ã‚¹ã‚¯ä½¿ç”¨é‡ã‚’è¨ˆç®—ã—ï¼Œãƒªã‚¹ãƒˆã¸è¿½åŠ ã™ã‚‹
    $tstksz = 0
    $stksz_estimated = []
    $root_apri.each do |id|
       $stksz_estimated.push(calc_stksz(id[1]))
    end

    # タスクのスタック使用量の最大値を決定
    # ãƒªã‚¹ãƒˆä¸­ã®è¦ç´ ã®æœ€å¤§å€¤ãŒã‚¿ã‚¹ã‚¯ã®æœ€å¤§ã‚¹ã‚¿ãƒƒã‚¯ä½¿ç”¨é‡ã¨ãªã‚‹ï¼Ž
    $tstksz = 0
    $stksz_estimated.each do |size|
        if size > $tstksz
                $tstksz = size
        end
    end

    # 確認
    $kernelCfgC.add2(<<EOS)
 * List of Estimated Total Stack Sizes of Tasks = #{$stksz_estimated}
 * Estimated Maximum Total Stack Size of Tasks = #{$tstksz}
 */
#define TOPPERS_TSTKSZ          (#{$tstksz})
EOS

    #
    #  優å…
ˆåº¦å‰²ã‚Šå½“て結果を標準出力へ表示
    #
    puts <<~EOS
      =====================================
      Task priority configuration result: 
    EOS
    @reallocate_atskpri.each do |e|
      puts "\t#{$cfgData[@api][e[0]][:tskid].str}:\tIPRI = #{e[1]}, EXEPRI = #{@reallocate_etskpri[e[0]]}\n"
    end
    puts "====================================="


  end
end

#
#  タスク管理に関する情
å ±ã®ç”Ÿæˆ
#

# 実行時優å…
ˆåº¦ã®ã‚³ãƒ³ãƒ•ã‚£ã‚®ãƒ¥ãƒ¬ãƒ¼ã‚·ãƒ§ãƒ³ã«æˆåŠŸã—たかどうか
$defepr_success = true

$kernelCfgC.comment_header("Task Management Functions")
if $cfgData[:CRE_TSK].size() == 0
  error("no task is registered")
end

TaskObject.new.generate()