無償ツールで設計効率の向上を体験 ―― HDLコードの記述ルール・チェックを体験する

2．検査・修正機能の利用

　ソース・コードによっては，警告がたくさんでることがあります．そのためALINTの設定を行うと便利になります．ALINTには，対象とするルールを選択したり，ルールによって分類して表示する機能があります．

（1）適用するルールの選択

　メニューから「ALINT」→「ALINT Options」を選択し，適用する規則の設定を図5のALINT Optionsウィンドウで行います．

　ALINT CommonタブのActive policy欄に「STARC_ALL」と入力します．警告が多いときは「STARC_TOP23」にします．設定可能なルールは表1の通りです．このほか，Configuration Managerを使うと，自由にルールを設定できます．

図5 適用するルールの指定

表1 用意されているルール

（2）ルールによる分類

　ALINT OptionsウィンドウのALINT Outputタブを選択し，ルールによる分類の指定を行います．

　図6のように，Generate AVDB fileをチェックするとViolation Viewerを利用できるようになります．コンパイル時に拡張子が.advbというファイルが生成されます．advbファイルは，ソース・コードのファイル名と同じにしておくと便利です．Violation messages outputの「File」を選択するとログ・ファイルを保存します．

図6 ルールによる分類の指定

　コンソール画面では，コマンドの実行と結果を確認できます．図7は，コンパイル・エラーはなく，ALINTの4種類の違反がある例です．

図7 コンソール画面の表示

　メニューから「ALINT」→「ALINT Violation Viewer」を選択し，advbファイルを読み込みます．

　図8がViolation Viewerの画面です．画面の下のModulesやRulesetsなどのタブを選択すると，必須（Rule）や推奨（Recommendation）の区分ごとに表示したり，ファイルごとに表示したりします．違反するファイルの警告をダブルクリックすると，ファイルを開き該当する行を表示するので警告の分析と処理に役立ちます．

図8 ALINT Violation Viewer

　図8では，Rule（必須），Recommendation1（推奨1），Recommendation2（推奨2）の3種類の分類の合計四つの規則に反していることが分かります．

• 推奨2の1.1.1の1番目の規則である「モジュール名とファイル名が同一である」に反している
• 3.5.6の3番目の規則である「可読性を高めるため宣言ごとに注釈（コメント）をつける」に反している
• 推奨1の3.5.3の3番目の規則である「ファイルの先頭の注釈の書式に従っていない」

　ファイルの先頭の注釈は，03_naming_bnf_headersのfixedフォルダの中に先頭の書式例があります．リスト2に修正したソース・コードの例を示します．

リスト2 修正したソース・コード

（3）複数のソース・コードを一括チェック

　ここまでは画面に表示したファイルだけをコンパイルするCompileメニューを利用しました．ALINTメニューは，ソース・コードの検査だけを実行します．

　複数のファイルのチェックを行いたい場合は，ALINTメニューを利用します．ALINTメニューを利用すると，ALINTコマンドを実行しています．

　Quick Guideのソース・コードを実習すれば，ALINTで出る警告の半分くらいに対処できるようになるかもしれません．あるいは，最初から警告が出ないようなコードが書けるようになっているかもしれません．

　ただし，すべての規則を守ることがよいとは限りません．規則を守らない方がよい場合には，MISRA-Cのように逸脱の手続きとして根拠を文書化するとよいでしょう^（6）．C言語におけるMISRA-Cでは，特定の場合には規則を守らない方が品質が高くなる場合があり，「逸脱の手続き」を取ることも規則になっています．