source: asp_ewarm/asp-1.7.0/doc/user.txt@ 61

Last change on this file since 61 was 61, checked in by ertl-honda, 11 years ago

ASP for EWARM のコミット．
File size: 84.0 KB
Line 
1
2 TOPPERS/ASPカーネル
3 ユーザーズマニュアル
4
5 対応バージョン: Release 1.7.0
6 最終更新: 2011年5月8日
7
8このドキュメントは，TOPPERS/ASPカーネルを使用するために必要な事項を説明
9するものである．
10
11----------------------------------------------------------------------
12 TOPPERS/ASP Kernel
13 Toyohashi Open Platform for Embedded Real-Time Systems/
14 Advanced Standard Profile Kernel
15
16 Copyright (C) 2005-2011 by Embedded and Real-Time Systems Laboratory
17 Graduate School of Information Science, Nagoya Univ., JAPAN
18
19 上記著作権者は，以下の(1)〜(4)の条件を満たす場合に限り，本ソフトウェ
20 ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
21 変・再配布（以下，利用と呼ぶ）することを無償で許諾する．
22 (1) 本ソフトウェアをソースコードの形で利用する場合には，上記の著作
23 権表示，この利用条件および下記の無保証規定が，そのままの形でソー
24 スコード中に含まれていること．
25 (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
26 用できる形で再配布する場合には，再配布に伴うドキュメント（利用
27 者マニュアルなど）に，上記の著作権表示，この利用条件および下記
28 の無保証規定を掲載すること．
29 (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
30 用できない形で再配布する場合には，次のいずれかの条件を満たすこ
31 と．
32 (a) 再配布に伴うドキュメント（利用者マニュアルなど）に，上記の著
33 作権表示，この利用条件および下記の無保証規定を掲載すること．
34 (b) 再配布の形態を，別に定める方法によって，TOPPERSプロジェクトに
35 報告すること．
36 (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
37 害からも，上記著作権者およびTOPPERSプロジェクトを免責すること．
38 また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
39 由に基づく請求からも，上記著作権者およびTOPPERSプロジェクトを
40 免責すること．
41
42 本ソフトウェアは，無保証で提供されているものである．上記著作権者お
43 よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
44 に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
45 アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
46 の責任を負わない．
47
48 $Id: user.txt 2069 2011-05-08 08:45:03Z ertl-hiro $
49----------------------------------------------------------------------
50
51○目次
52
53１．TOPPERS/ASPカーネルの概要
54 1.1 TOPPERS/ASPカーネルの位置付け
55 1.2 TOPPERS/ASPカーネルの仕様
56 1.3 マイグレーションガイド
57 1.4 機能拡張・チューニングガイド
58 1.5 既知の問題
59２．ターゲット依存部
60 2.1 ターゲット依存部の概要
61 2.2 簡易パッケージ
62 2.3 個別パッケージ
63３．クイックスタートガイド
64 3.1 開発環境の準備
65 3.2 コンフィギュレータの構築
66 3.3 サンプルプログラムの構築と実行
67 3.4 カーネルを関数単位でライブラリ化する方法
68 3.5 アプリケーションとカーネルを別々に構築する方法
69４．ディレクトリ構成・ファイル構成
70 4.1 配布パッケージのディレクトリ構成
71 4.2 ターゲット非依存部のファイル構成
72５．コンフィギュレーションスクリプトの使い方
73６．Makefileの修正方法
74 6.1 Makefileの変数定義
75 6.2 コンパイルオプション
76７．コンフィギュレータの使い方
77８．システムサービス
78 8.1 システムログ機能
79 8.1.1 システムログ機能の位置付け
80 8.1.2 ログバッファへの記録と低レベル出力
81 8.1.3 ログ情報の種別
82 8.1.4 ログ情報の重要度
83 8.1.5 ログ情報のデータ構造
84 8.1.6 システムログ機能のサービスコール
85 8.1.7 システムログ機能のためのライブラリ関数とマクロ
86 8.1.8 システムログ機能のその他のサービス
87 8.2 シリアルインタフェースドライバ
88 8.2.1 シリアルインタフェースドライバのサービスコール
89 8.2.2 シリアルインタフェースドライバのその他のサービス
90 8.3 システムログタスク
91 8.3.1 システムログタスクのサービスコール
92 8.3.2 システムログタスクのその他のサービス
93 8.4 カーネル起動メッセージの出力
94９．サポートライブラリ
95 9.1 基本的なライブラリ関数
96 9.2 キュー操作ライブラリ関数
97 9.3 システムログ出力用ライブラリ関数
98 9.4 実行時間分布集計モジュール
99１０．テストプログラム
100 10.1 テストプログラム用ライブラリ
101 10.2 カーネルの整合性検査
102 10.3 機能テストプログラム
103 10.4 性能評価プログラム
104１１．使用上の注意とヒント
105 11.1 タイマドライバの組込み
106 11.2 assertマクロの処理
107 11.3 システムログ機能の扱い
108 11.4 オブジェクトIDの管理
109 11.5 カーネルの内部シンボルのリネーム
110 11.6 トレースログ記録のサンプルコードの使用方法
111 11.7 システムの起動時の初期化処理
112１２．参考情報
113 12.1 利用条件と利用報告
114 12.2 保証・適用性・サポート
115 12.3 バグレポート
116 12.4 ウェブサイト
117 12.5 TOPPERSユーザーズメーリングリスト
118 12.6 TOPPERSプロジェクトのメンバ向けのサービス
119 12.7 TOPPERSプロジェクトへの参加
120１３．リファレンス
121 13.1 サービスコール一覧
122 13.2 静的API一覧
123 13.3 バージョン履歴
124
125
126１．TOPPERS/ASPカーネルの概要
127
1281.1 TOPPERS/ASPカーネルの位置付け
129
130TOPPERS/ASPカーネル（以下，ASPカーネル）は，TOPPERS新世代カーネルの基盤
131となるものとして，TOPPERSプロジェクトにおいて開発したリアルタイムカーネ
132ルである．μITRON4.0仕様のスタンダードプロファイル準拠のリアルタイムカー
133ネルであるTOPPERS/JSPカーネルを拡張・改良する形で開発した．
134
1351.2 TOPPERS/ASPカーネルの仕様
136
137ASPカーネルの仕様の概要については，「TOPPERS/ASPカーネルの仕様概要」を
138参照すること．また，ASPカーネルを含むTOPPERS新世代カーネルの仕様の詳細
139については，別途PDFファイルの形で配布している「TOPPERS新世代カーネル統
140合仕様書」を参照すること．
141
1421.3 マイグレーションガイド
143
144従来のTOPPERSカーネルや他のμITRON4.0仕様準拠のカーネルから，TOPPERS新
145世代カーネルに移行するための方法（またはヒント）を説明した「TOPPERS新世
146代カーネルへのマイグレーションガイド」を，別途PDFファイルの形で配布して
147いる．必要に応じて参照すること．
148
1491.4 機能拡張・チューニングガイド
150
151TOPPERS/ASPカーネルを，機能拡張・チューニングするための方法（またはヒン
152ト）を説明した「機能拡張・チューニングガイド」を用意している．拡張パッ
153ケージの使用方法は，「機能拡張・チューニングガイド」に含まれている．必
154要に応じて参照すること．
155
1561.5 既知の問題
157
158割込みサービスルーチンの先頭番地（ATT_ISRのisr），割込みハンドラの先頭
159番地（DEF_INHのinthdr），CPU例外ハンドラの先頭番地（DEF_EXCのexchdr），
160初期化ルーチンの先頭番地（ATT_INIのinirtn），終了処理ルーチンの先頭番地
161（ATT_TERのterrtn）がプログラムの開始番地として正しくない場合のエラーは，
162コンフィギュレータに検出されない場合がある（ターゲットに依存）．
163
164kernel_cfg.c（およびcfg1_out.c）は，カーネル，システムサービス，アプリ
165ケーションのいずれのインクルードファイルもインクルードし，いずれのシン
166ボルも参照する可能性がある．そのため，カーネル，システムサービス，アプ
167リケーションでシンボル等が衝突している場合や，コンパイルオプションが食
168い違っている場合に，kernel_cfg.c（およびcfg1_out.c）が正しくコンパイル
169できなくなる場合が考えられる．カーネルのシンボルをリネームするなどの方
170法で軽減されてはいるが，問題がなくなっているわけではない．
171
172システムコンフィギュレーションファイルから，コンフィギュレータに対する
173INCLUDEディレクティブにより他のコンフィギュレーションファイルをインクルー
174ドしている場合に，その中に含まれるC言語プリプロセッサのインクルードディ
175レクティブ（#include）で，コンフィギュレーションファイルの置かれている
176ディレクトリが，ファイルを検索するパスにはいらないという問題がある．例
177えば，syssvc/syslog.cfgに「#include "syslog.h"」と記述できないのは，こ
178の問題があるためである．
179
180現時点では，アドレスが64ビットの環境には対応していない．64ビットアドレ
181ス環境をサポートするための最大の課題は，モトローラSレコードフォーマット
182が64ビットアドレスに対応していないことである．
183
184
185２．ターゲット依存部
186
1872.1 ターゲット依存部の概要
188
189ASPカーネルのターゲット非依存部と，各種のターゲットシステムに対応するた
190めのターゲット依存部は，別々に開発されている．そのため，ASPカーネルが対
191応しているすべてのターゲット依存部を，バージョンを整合させてパッケージ
192化することは困難である．そこで，主に初級のユーザを対象にした簡易パッケー
193ジと，上級のユーザやカーネル開発者を対象にした個別パッケージを用意して
194いる．
195
196ASPカーネルを未サポートのターゲットシステムへポーティングするために必要
197な作業は，開発環境の構築と標準の開発環境との差異の吸収，カーネル自身の
198ポーティング，システムサービスのポーティングなどからなる．詳しくは，
199「ターゲット依存部 ポーティングガイド」を参照すること．
200
2012.2 簡易パッケージ
202
203簡易パッケージは，ASPカーネルが対応しているターゲットシステム毎に用意さ
204れ，そのターゲットシステム上でASPカーネルを動作させるために必要なファイ
205ル一式をパッケージ化したものである．簡易パッケージに含まれるファイルは，
206バージョンが整合していることが確認されている．
207
208簡易パッケージのバージョン番号は，パッケージ化した日付とすることを原則
209とするが，ターゲットシステム毎の事情によりこの原則に従わない場合がある．
210
211簡易パッケージは，基本的には，次に説明する個別パッケージを複数まとめた
212ものである．そのため，対象ターゲットシステムに必要のないファイルも含ま
213れている．また，簡易パッケージに含まれている個別パッケージのバージョン
214は，個別パッケージのMANIFESTファイルを参照することで知ることができる．
215
2162.3 個別パッケージ
217
218個別パッケージは，ASPカーネルの開発単位毎に，その開発単位で開発を担当し
219ているファイル一式をパッケージ化したものである．ASPカーネルのターゲット
220非依存部も，一つの個別パッケージとして配布される．ある個別パッケージを
221使用するためには，一般には，他の個別パッケージが必要となる．ターゲット
222依存部の個別パッケージを使用するために必要となる個別パッケージとそのバー
223ジョンについては，ターゲット依存部のユーザーズマニュアルを参照すること．
224使用する個別パッケージのバージョンを整合させることは，ユーザの責任であ
225る．
226
227個別パッケージのバージョン番号は，X.Y.Zの形で表現される．ターゲット非依
228存部のバージョン番号を，ASPカーネル全体のリリース番号とする．ターゲット
229依存部のバージョン番号は，XとYが，それが依存するターゲット非依存部と一
230致している．それに対して，Zは一致しているとは限らない．例えば，ターゲッ
231ト非依存部のバージョン1.1.0に対応するターゲット依存部は，バージョン
2321.1.Zの形となる．ターゲット依存部のみがバージョンアップした場合には，Z
233が変更される．
234
235使用する個別パッケージは，次の例のように，ターゲット非依存部の個別パッ
236ケージを展開したのと同じディレクトリで展開する．
237
238 % tar xvfz asp-1.1.0.tar.gz
239 % tar xvfz asp_arch_arm_gcc_1.1.2.tar.gz
240
241ターゲット非依存部の個別パッケージには，以下のターゲット依存部が含まれ
242ているが，これらは他のターゲットシステムにポーティングする際の参考にす
243るために用意しているものであり，その動作については未検証である．
244
245 target/dve68k_gcc DVE-68K/40（GNU開発環境）用ターゲット依存部
246 arch/m68k_gcc M68040（GNU開発環境）用プロセッサ依存部
247 pdic/upd72001 μPD72001用 簡易SIOドライバ
248
249
250３．クイックスタートガイド
251
252ここでは，ターゲット依存部が用意されているターゲットシステム上で，ASPカー
253ネル上で動作するサンプルプログラムを構築・動作させるまでの手順を示す．
254
2553.1 開発環境の準備
256
257ASPカーネルを用いたシステム構築には，以下のツールが必要である．
258
259 ホストシステム用のツール
260 perl 動作確認：5.10.0
261 GNU Make 動作確認：3.81
262
263 TOPPERS新世代カーネル用コンフィギュレータ
264 cfg 動作確認：1.7.0
265 ※ 1.5以前のバージョンでは動作しない．
266
267 ターゲットシステム用のツール（クロス開発環境）
268 標準規格に準拠したCコンパイラ
269 アセンブラ，リンカ，ライブラリアン
270 シンボルファイル出力ツール，ヘキサファイル出力ツール
271 標準Cライブラリ（必須ではない）
272
273ターゲットシステム用のツールにGNU開発環境を用いる場合には，以下のツール
274が必要である．
275
276 ターゲットシステム用のGNU開発環境ツール
277 BINUTILS（as，ld，ar，nm，ranlib，objcopy，objdump）
278 GCCまたはGCC-CORE（gccおよびそこから呼び出されるツール）
279 NEWLIB（標準Cライブラリ，必須ではない）
280
281動作確認されているターゲットシステム用のツールについては，ターゲット依
282存部のユーザーズマニュアルを参照すること．
283
284ターゲットシステム用の標準Cライブラリは，アプリケーションが標準Cライブ
285ラリを使用しない場合には，必要ない．ただし，コンパイラが標準Cライブラリ
286関数（memcpy，memsetなど）を呼び出すコードを生成する場合があり，その場
287合には標準Cライブラリが必要である．標準Cライブラリを用意する代わりに，
288生成したコードが呼び出す関数のみを自分で用意してもよい．
289
290以下では，これらのツールが用意できていることを前提に，UNIXマシン上での
291構築手順を説明する．また以下の説明では，makeコマンドがGNU Makeであるも
292のとする（ASPカーネルのサンプルのMakefileは，GNU Makeの拡張機能を用いて
293いる）．
294
2953.2 コンフィギュレータの構築
296
297カーネルを構築する前に，まず，TOPPERS新世代カーネル用コンフィギュレータ
298を構築する必要がある．簡易パッケージに含まれていた場合など，コンフィギュ
299レータを実行ファイル形式で入手した場合には，このステップは必要ない．
300
301コンフィギュレータの構築には，以下のツールが必要である．
302
303 ホストシステム用のツール（セルフ開発環境）
304 C++コンパイラ，C++ライブラリ
305 動作確認（Mac OS X環境）：GNU C++ 4.2.1
306 Boost 動作確認：1.42.0
307 GNU Make 動作確認：3.81
308
309最初に，パッケージにコンフィギュレータのソースファイルが含まれていない
310場合には，コンフィギュレータのパッケージを，ASPカーネルのソースファイル
311を展開したディレクトリの下に展開する．
312
313 % cd asp
314 % tar xvfz cfg-1.6.0.tar.gz
315
316または，コンフィギュレータのパッケージを他のディレクトリに展開し，ASPカー
317ネルのソースファイルを展開したディレクトリからシンボリックリンクをはっ
318てもよい．
319
320ソースファイルが展開できると，cfgディレクトリに移動し，コンフィギュレー
321ションスクリプト（configure）でMakefileの環境依存部（Makefile.config）
322を生成した後，makeコマンドによりコンフィギュレータ（cfgプログラム）が構
323築できる．
324
325 % cd cfg
326 % ./configure
327 % make
328
329ただし，Boostをインストールしたディレクトリおよび名称が標準で想定してい
330るものとは違う場合には，configureの--with-headersおよび--with-libraries
331オプションにより，ヘッダファイルおよびライブラリの置かれたディレクトリ
332を指定する必要がある．
333
334また，ホストシステムによっては，最適化レベルを上げると正しくコンパイル
335できないことが知られている．そのような場合には，最適化レベルを下げるか，
336最適化を抑止するように，Makefileを修正する必要がある．
337
338なお，コンフィギュレータの使用方法については，「７．コンフィギュレータ
339の使い方」の章で説明する．
340
3413.3 サンプルプログラムの構築と実行
342
343次に，ASPカーネル上で動作するサンプルプログラムを構築する方法を説明する．
344
345まず，サンプルプログラムのオブジェクトファイルを置くディレクトリを作成
346し，コンフィギュレーションスクリプトを実行する．例えば，オブジェクトファ
347イルを置くディレクトリを，ASPカーネルのソースファイルを展開したディレ
348クトリの下のOBJという名称のディレクトリにする場合には，次のコマンドを
349実行する（ディレクトリの場所と名称は任意に決めてよい）．
350
351 % cd asp
352 % mkdir OBJ
353 % cd OBJ
354 % perl ../configure -T <ターゲット略称>
355
356ここで，<ターゲット略称>は，targetディレクトリの下に置かれているターゲッ
357ト依存部ディレクトリの名称である．コンフィギュレーションスクリプトのオ
358プションについては，「５．コンフィギュレーションスクリプトの使い方」の
359章で説明する．
360
361コンフィギュレーションスクリプトの実行により，カレントディレクトリには，
362サンプルプログラムを構築するためのMakefile，サンプルプログラム用のコン
363フィギュレーションファイル（sample1.cfg），サンプルプログラム本体
364（sample1.hおよびsample1.c）が生成される．
365
366コンフィギュレーションスクリプトの実行後，必要であればMakefileを修正す
367る．Makefileの修正方法については，「６．Makefileの修正方法」の章で説明
368する．
369
370その後，make dependで依存関係ファイル（Makefile.depend）を生成した後，
371makeコマンドによりサンプルプログラムのロードモジュール（aspまたは
372asp.exe）が生成できる．依存関係ファイルの生成には若干時間がかかる．
373
374 % make depend
375 % make
376
377ここで構築したサンプルプログラム（sample1.h，sample1.c，sample1.cfg）
378は，ASPカーネルの基本的な動作を確認するためのものである．このプログラ
379ムの概要説明は，sample1.cの先頭のコメントにある．
380
3813.4 カーネルを関数単位でライブラリ化する方法
382
383前節の手順では，カーネルをファイル単位でコンパイルし，ライブラリ化して
384いたが，カーネルのコードサイズを縮小するためには，使用しないサービスコー
385ルはリンクしない方が望ましい．そこでASPカーネルでは，カーネルを関数単位
386でコンパイルし，ライブラリ化する方法を用意している．
387
388この方法でサンプルプログラムを構築するには，コンフィギュレーションスク
389リプトに，それを指示するオプション（-f）を付加するだけでよい．
390
391 % mkdir OBJ_LIB
392 % cd OBJ_LIB
393 % perl ../configure -T <ターゲット略称> -f
394
395ここで，OBJ_LIBというディレクトリの場所と名称は，任意に決めてよい．これ
396以降の手順は，前節と同じである．
397
3983.5 アプリケーションとカーネルを別々に構築する方法
399
400前節で説明した方法では，アプリケーションとカーネルを同時に生成するため，
401オブジェクトファイルを置くディレクトリに非常に多くのファイルが作成され
402て，扱いにくくなる．そこで，カーネルを修正する頻度が低い場合には，カー
403ネルは事前に構築しておき，後でアプリケーションだけを構築する方法を用意
404している．以下では，サンプルプログラムを構築を例に，その手順について説
405明する．
406
407まず，カーネルを構築するディレクトリを作成し，コンフィギュレーションス
408クリプトを実行する．例えば，カーネルを構築するディレクトリを，ASPカー
409ネルのソースファイルを展開したディレクトリの下のKERNEL_LIBという名称の
410ディレクトリにする場合には，次のコマンドを実行する（ディレクトリの場所
411と名称は任意に決めてよい）．
412
413 % mkdir KERNEL_LIB
414 % cd KERNEL_LIB
415 % perl ../configure -T <ターゲット略称> -f
416
417これにより，カーネルを構築するディレクトリに，Makefile，sample1.cfg，
418sample1.h，sample1.cが生成されるが，Makefile以外は実質的には使用しない．
419
420make dependで依存関係ファイル（Makefile.depend）を生成した後，make
421libkernel.aによりカーネルライブラリ（libkernel.a）が生成できる．
422
423 % make depend
424 % make libkernel.a
425
426次に，アプリケーションを構築するディレクトリを作成し，コンフィギュレー
427ションスクリプトを実行する．例えば，アプリケーションを構築するディレク
428トリを，ASPカーネルのソースファイルを展開したディレクトリの下のAPLとい
429う名称のディレクトリにする場合には，次のコマンドを実行する（ディレクト
430リの場所と名称は任意に決めてよい）．
431
432 % cd ..
433 % mkdir APL
434 % cd APL
435 % perl ../configure -T <ターゲット略称> -L ../KERNEL_LIB
436
437ここで-Lオプションには，カーネルを構築したディレクトリのパスを指定する．
438
439最後に，make dependで依存関係ファイル（Makefile.depend）を生成した後，
440makeコマンドによりサンプルプログラムのロードモジュール（aspまたは
441asp.exe）が生成できる．
442
443 % make depend
444 % make
445
446この手順では，アプリケーション構築時にはカーネルの再構築が必要かチェッ
447クしないため，カーネルのソースコードを修正した場合には，カーネルを構築
448したディレクトリでmake libkernel.aを再実行する必要がある．
449
450以上では，カーネルとアプリケーションを別々のディレクトリで構築したが，
451-Lオプションにカレントディレクトリ（ただし，"."という記述では不可）を指
452定することで，カーネルとアプリケーションを同じディレクトリで別々に構築
453することもできる．具体的には，次の手順となる．
454
455 % mkdir OBJ
456 % cd OBJ
457 % perl ../configure -T <ターゲット略称> -L ../OBJ
458 % make depend
459 % make libkernel.a
460 % make cleankernel
461 % make
462
463ここで，make cleankernelは，カーネルライブラリを生成するための中間ファ
464イルを削除するものである．この手順では，make dependによりカーネルライ
465ブラリに関する依存関係を生成しないため，カーネルのソースコードを修正し
466た場合には，必ずmake cleankernel（または，make clean）してから，make
467libkernel.aする必要があるので注意すること．
468
469なお，make realcleanすると，make dependとmakeにより生成したファイルをす
470べて削除する．それに対して，make cleanでは，make dependにより生成した依
471存関係ファイルは削除しない．
472
473
474４．ディレクトリ構成・ファイル構成
475
4764.1 配布パッケージのディレクトリ構成
477
478 include/ アプリケーション向けヘッダファイル
479 kernel/ カーネルソースファイル
480 syssvc/ システムサービスヘッダファイル，ソースファイル
481 library/ サポートライブラリソースファイル
482 target/ ターゲット依存部
483 arch/ ターゲット依存部の共通部分
484 gcc/ GCC開発環境依存部
485 logtrace/ トレースログ記録のサンプルコード
486 pdic/ PDIC（デバイスドライバのOS非依存部分）
487 utils/ ユーティリティプログラム
488 sample/ サンプルプログラムとMakefile
489 doc/ ドキュメント
490 test/ テストプログラム
491 extension/ 拡張パッケージ
492
4934.2 ターゲット非依存部のファイル構成
494
495ターゲット非依存部（テストプログラムと拡張パッケージは除く）の各ファイ
496ルの概要は次の通り．
497
498 README.txt TOPPERS/ASPカーネルの簡単な紹介
499 configure コンフィギュレーションスクリプト（GNU開発環境用）
500 MANIFEST 個別パッケージのファイルリスト
501
502 include/
503 kernel.h ASPカーネルを使用するための定義
504 sil.h システムインタフェースレイヤを使用するための定義
505 t_stddef.h TOPPERS共通ヘッダファイル
506 itron.h ITRON仕様共通規定のデータ型・定数・マクロ
507 t_syslog.h システムログ出力を行うための定義
508 t_stdlib.h 基本的なライブラリ関数を使用するための定義
509 queue.h キュー操作ライブラリを使用するための定義
510 test_lib.h テストプログラム用ライブラリを使用するための定義
511 histogram.h 実行時間分布集計モジュールを使用するための定義
512 log_output.h システムログのフォーマット出力を使用するための定義
513
514 kernel/
515 Makefile.kernel カーネルのファイル構成の定義
516 kernel_impl.h カーネル実装用標準ヘッダファイル
517 kernel_int.h kernel_cfg.c用のヘッダファイル
518 kernel_rename.def カーネルの内部識別名のリネーム定義
519 kernel_rename.h カーネルの内部識別名のリネーム
520 kernel_unrename.h カーネルの内部識別名のリネーム解除
521 kernel_api.csv コンフィギュレータの静的APIテーブル
522 kernel_def.csv コンフィギュレータの値取得シンボルテーブル
523 kernel.tf コンフィギュレータのパス2のテンプレートファイル
524 kernel_check.tf コンフィギュレータのパス3のテンプレートファイル
525 genoffset.tf オフセットファイル生成用のテンプレートファイル
526 allfunc.h すべての関数をコンパイルするための定義
527 check.h エラーチェック用マクロ
528 startup.c カーネルの初期化と終了処理
529 task.h タスク操作ルーチン関連の定義
530 task.c タスク操作ルーチン
531 wait.h 待ち状態操作ルーチン関連の定義
532 wait.c 待ち状態操作ルーチン
533 time_event.h タイムイベント管理関連の定義
534 time_event.c タイムイベント管理
535 task_manage.c タスク管理機能
536 task_refer.c タスク状態参照機能
537 task_sync.c タスク付属同期機能
538 task_except.c タスク例外処理機能
539 semaphore.h セマフォ機能関連の定義
540 semaphore.c セマフォ機能
541 eventflag.h イベントフラグ機能関連の定義
542 eventflag.c イベントフラグ機能
543 dataqueue.h データキュー機能関連の定義
544 dataqueue.c データキュー機能
545 pridataq.h 優先度データキュー機能関連の定義
546 pridataq.c 優先度データキュー機能
547 mailbox.h メールボックス機能関連の定義
548 mailbox.c メールボックス機能
549 mempfix.h 固定長メモリプール機能関連の定義
550 mempfix.c 固定長メモリプール機能
551 time_manage.c システム時刻管理機能
552 cyclic.h 周期ハンドラ機能関連の定義
553 cyclic.c 周期ハンドラ機能
554 alarm.h アラームハンドラ機能関連の定義
555 alarm.c アラームハンドラ機能
556 sys_manage.c システム状態管理機能
557 interrupt.h 割込み管理機能関連の定義
558 interrupt.c 割込み管理機能
559 exception.h CPU例外管理機能関連の定義
560 exception.c CPU例外管理機能
561
562 syssvc/
563 banner.h カーネル起動メッセージの出力のための定義
564 banner.c カーネル起動メッセージの出力
565 banner.cfg カーネル起動メッセージの出力のコンフィギュレー
566 ションファイル
567 logtask.h システムログタスクを使用するための定義
568 logtask.c システムログタスク
569 logtask.cfg システムログタスクのコンフィギュレーションファイル
570 serial.h シリアルインタフェースドライバを使用するための定義
571 serial.c シリアルインタフェースドライバ
572 serial.cfg シリアルドライバのコンフィギュレーションファイル
573 syslog.h システムログ機能を使用するための定義
574 syslog.c システムログ機能
575 syslog.cfg システムログ機能のコンフィギュレーションファイル
576 vasyslog.c 可変数引数のシステムログライブラリ
577
578 library/
579 histogram.c 実行時間分布集計モジュール
580 log_output.c システムログのフォーマット出力
581 strerror.c エラーメッセージ文字列を返す関数
582 t_perror.c エラーメッセージの出力
583 test_lib.c テストプログラム用ライブラリ
584
585 arch/gcc/
586 MANIFEST 個別パッケージのファイルリスト
587 tool_stddef.h t_stddef.hの開発環境依存部（GCC用）
588
589 arch/logtrace/
590 MANIFEST 個別パッケージのファイルリスト
591 trace_config.h トレースログに関する設定
592 trace_config.c トレースログ機能
593 trace_dump.c トレースログのダンプ
594
595 utils/
596 applyrename ファイルにリネームを適用
597 genoffset offset.hの生成（GNU開発環境用）
598 genrename リネームヘッダファイルの生成
599 gentest テストプログラムの生成
600 makedep 依存関係リストの生成（GNU開発環境用）
601 makerelease リリースパッケージの生成
602
603 sample/
604 Makefile サンプルのMakefile（GNU開発環境用）
605 sample1.h サンプルプログラム(1)に関する定義
606 sample1.c サンプルプログラム(1)
607 sample1.cfg サンプルプログラム(1)のコンフィギュレーションファイル
608
609 doc/
610 user.txt ユーザーズマニュアル
611 asp_spec.txt TOPPERS/ASPカーネルの仕様概要
612 extension.txt 機能拡張・チューニングガイド
613 porting.txt ターゲット依存部 ポーティングガイド
614 configurator.txt コンフィギュレータ仕様
615 design.txt 設計メモ
616 version.txt 変更履歴
617
618
619５．コンフィギュレーションスクリプトの使い方
620
621コンフィギュレーションスクリプト（configure）は，ASPカーネルおよびアプ
622リケーションプログラムを構築するために必要な基本的なコンフィギュレーショ
623ンを行うためのプログラムである．
624
625ASPカーネルを用いてアプリケーションを作成する場合には，まずオブジェクト
626ファイルを置くディレクトリを作成し，そのディレクトリでコンフィギュレー
627ションスクリプトを実行する．オブジェクトファイルを置くディレクトリの場
628所と名称は，任意に決めてよい．
629
630コンフィギュレーションスクリプトに対するオプションは次の通り．
631
632 -T <ターゲット略称>
633 ターゲットシステムの名称を，targetディレクトリの下に置かれてい
634 るターゲット依存部ディレクトリの名称で指定する（必須）．
635
636 -A <アプリケーションプログラム名>
637 アプリケーションプログラムの名称を指定する．省略した場合には，
638 サンプルプログラム（sample1）となる．
639
640 -a <アプリケーションのディレクトリ名>
641 アプリケーションプログラムのソースファイル（システムコンフィギュ
642 レーションファイルを除く）を置いたディレクトリ名を指定する．省
643 略した場合には，オブジェクトファイルを置くディレクトリに置かれ
644 ていることを仮定する．システムコンフィギュレーションファイルは，
645 オブジェクトファイルを置くディレクトリに置くこと．
646
647 -U <オブジェクトファイル名>
648 アプリケーションプログラムのメインのオブジェクトファイル（-A
649 で指定したアプリケーションプログラム名に".o"を付加したもの）以
650 外に，リンクすべきオブジェクトファイルの名称を，".o"を付加した
651 形で指定する．""で囲むことによって，複数のファイルを指定するこ
652 とも可能である（-Uオプションを複数使ってはならない）．
653
654 -L <カーネルライブラリのディレクトリ名>
655 事前に構築したカーネルライブラリ（libkernel.a）を用いて，アプリ
656 ケーションのみを構築する場合には，このオプションにカーネルライ
657 ブラリの置かれたディレクトリ名を指定する．このオプションの使用
658 例については，「3.5 アプリケーションとカーネルを別々に構築する
659 方法」の節を参照すること．
660
661 -f
662 カーネルを関数単位でコンパイルしライブラリ化する場合に，このオ
663 プションを指定する．このオプションの使用例については，「3.4 カー
664 ネルを関数単位でライブラリ化する方法」の節を参照すること．
665
666 -D <ASPカーネルのソースディレクトリ名>
667 ASPカーネルのソースファイルを置いたディレクトリ名を指定する．省
668 略した場合には，configureの置かれているディレクトリとなる．
669
670 -l <プログラミング言語>
671 アプリケーションプログラムのプログラミング言語を指定する．現時
672 点では，cとc++のみをサポートしている．
673
674 -t <テンプレートディレクトリ名>
675 Makefileやサンプルプログラムのテンプレートの置かれたディレクト
676 リ名を指定する．省略した場合には，ASPカーネルのソースファイルを
677 置いたディレクトリの下のsampleディレクトリとなる．
678
679 -m <テンプレートMakefile名>
680 Makefileのテンプレートとするファイル名を指定する．省略した場合
681 には，Makefileとなる．
682
683 -d <実行環境名>
684 ターゲットシステム上でのプログラムの実行環境（ないしは，デバッ
685 グ環境）の名称を指定する．このオプションを指定すると，実行環境
686 を指定するシンボル（TOPPERS_<デバッグ環境名>）がマクロ定義され
687 る．省略した場合には，実行環境を指定するシンボルはマクロ定義さ
688 れない．
689
690 -r
691 トレースログ記録のサンプルコードを有効にする場合に，このオプショ
692 ンを指定する．このオプションの使用例については，「11.6 トレース
693 ログ記録のサンプルコードの使用方法」の節を参照すること．
694
695 -p <perlのパス名>
696 perlのパス名を指定する．省略した場合には，/usr/local/binと
697 /usr/binを探索し，perlのパス名を決定する．
698
699 -g <コンフィギュレータのパス名>
700 コンフィギュレータ（cfg）のパス名を指定する．省略した場合には，
701 デフォルトのパス名（ASPカーネルのソースディレクトリの下の
702 cfg/cfg/cfg）となる．
703
704コンフィギュレーションスクリプトが行う処理は次の通りである．
705
706(1) Makefileの生成
707
708テンプレートディレクトリ（デフォルトでは，sample）から適切なMakefileを
709選択し，必要な箇所を書き換えて，Makefileを生成する．
710
711(2) サンプルプログラムの生成
712
713指定したアプリケーションプログラムがテンプレートディレクトリにある場合，
714適切なアプリケーションプログラムのソースファイルを選択し，必要な箇所を
715書き換えて，アプリケーションプログラムのソースファイル（例えば，
716sample1.h，sample1.c，sample1.cfg）を生成する．
717
718(3) コンフィギュレータが用意できているかのチェック
719
720コンフィギュレータ（cfg）の実行ファイルがあるかチェックし，ファイルがな
721い場合には，その旨を出力する．
722
723
724６．Makefileの修正方法
725
726前の章で説明したように，コンフィギュレーションスクリプトに与えるオプショ
727ン等からMakefileが生成されるが，コンフィギュレーションスクリプトで対応
728できない場合には，Makefileを直接修正する必要がある．ここでは，Makefile
729の中で，修正が必要となる可能性の高い箇所について説明する．
730
731なお，Makefileを修正した後にコンフィギュレーションスクリプトを再実行す
732ると，修正したMakefileが上書きされてしまうので注意すること（古いものが
733Makefile.bakに保存される）．
734
7356.1 Makefileの変数定義
736
737(A) ターゲット略称
738
739TARGETには，ターゲットシステムの名称を，targetディレクトリの下に置かれ
740ているターゲット依存部ディレクトリの名称で指定する．この定義は，通常は，
741コンフィギュレーションスクリプトに対する-Tオプションにより行う．
742
743(B) オブジェクトファイルの拡張子
744
745Cygwin環境でコンパイルする時には，OBJEXTを"exe"に定義する必要がある．こ
746れは，Cygwin環境では，ロードモジュールのファイル名に拡張子".exe"が付加
747されるのに対応するためのものである．Cygwin環境であることを判定できれば，
748コンフィギュレーションスクリプトがこの定義を行う．
749
750(C) 実行環境（ターゲット依存）
751
752ターゲットによっては，実行環境に対応してターゲット依存部のコードを差し
753換える場合がある．これを可能にするために，実行環境の名称をDBGENVに定義
754している．この定義は，通常は，コンフィギュレーションスクリプトに対す
755る-Dオプションにより行う．どのターゲットがどの実行環境に対応しているか
756は，ターゲット依存部のユーザーズマニュアルを参照すること．
757
758(D) カーネルライブラリのディレクトリ名
759
760KERNEL_LIBには，カーネルライブラリの置かれたディレクトリ名を定義する．
761この定義は，通常は，コンフィギュレーションスクリプトに対する-Lオプショ
762ンにより行う．
763
764(E) カーネルを関数単位でコンパイルするかどうか
765
766KERNEL_FUNCOBJSは，カーネルを関数単位でコンパイルする場合にはtrueに定義
767し，ファイル単位でコンパイルする場合には未定義とする．この定義は，通常
768は，コンフィギュレーションスクリプトに対する-fオプションにより行う．
769
770(F) 共通コンパイルオプション
771
772すべてのプログラムに共通するコンパイルオプションの追加が必要な場合には，
773下の変数の定義を変更する．そのコンパイルオプションが，特定のターゲット
774で常に必要な場合には，ターゲット依存の定義を入れたMakefile.target等を修
775正すべきである．
776
777 CDEFS コンパイラに対する-Dオプションを記述する．
778 INCLUDES コンパイラに対する-Iオプションを記述する．
779 COPTS コンパイラに対するその他のオプションを記述する．
780 LDFLAGS リンカに対するオプションを記述する．
781 LIBS ライブラリリンクのためのオプションを記述する．
782
783追加の可能性のあるコンパイルオプションについては，「6.2 コンパイルオプ
784ション」の節を参照のこと．
785
786(G) アプリケーションプログラム名
787
788APPLNAMEには，アプリケーションプログラム名を定義する．システムコンフィ
789ギュレーションファイル名は，APPLNAMEに定義した名前に拡張子".cfg"を付加
790した名前とする．また，アプリケーションのメインファイルは，APPLNAMEに定
791義した名前に拡張子".c"を付加した名前とする．この定義は，通常は，コンフィ
792ギュレーションスクリプトに対する-Aオプションにより行う．
793
794(H) アプリケーションのディレクトリ名
795
796アプリケーションのソースファイルを，オブジェクトファイルを置くのとは別
797のディレクトリに置く場合には，APPLDIRにそのディレクトリ名を定義する．こ
798の定義は，通常は，コンフィギュレーションスクリプトに対する-aオプション
799により行う．アプリケーションのソースファイルを置くディレクトリが複数あ
800る場合には，APPL_DIRの定義を変更することで対応する．
801
802(I) アプリケーションのプログラムファイル名
803
804アプリケーションが複数のソースファイルで構成される場合には，そのオブジェ
805クトファイル名を，APPL_ASMOBJS，APPL_COBJS，APPL_CXXOBJSに列挙する．
806
807(J) アプリケーションのコンパイルオプション
808
809アプリケーションのコンパイルに必要なコンパイルオプションや，アプリケー
810ションがライブラリを必要とする場合には，APPL_CFLAGSおよびAPPL_LIBSに定
811義する．
812
813(K) ロードモジュールのファイル名
814
815標準のロードモジュールのファイル名をOBJNAMEに定義する．デフォルトはasp
816である．
817
818(L) ターゲットファイルの定義
819
820ターゲット"all"の依存ファイルとして，ロードモジュールの形式を指定する．
821具体的には，ELF形式の時は$(OBJFILE)，バイナリ形式の時は$(OBJNAME).bin，
822モトローラ S形式の時は$(OBJNAME).srecを指定する．$(OBJFILE)は，Cygwin
823環境でOBJEXTを"exe"に定義した時には$(OBJNAME).exe，そうでない場合には
824$(OBJNAME)となる．
825
826(M) makedepのオプションの定義
827
828Cygwin環境でルートディレクトリが"cygdrive"でない場合には，makedepの-Rオ
829プションでルートディレクトリ名を与える必要がある．また，Makefileのター
830ゲット部（":"の左側）に複数のファイル名を記述すると（カーネルを関数単位
831でライブラリ化する場合に，このような記述が生成される）正しく動作しない
832場合には（Cygwin環境のGNU Makeでこのような制限があるという報告がある），
833makedepに-Sオプションを付与する必要がある．
834
835makedepのオプションは，次の例のように，MAKEDEP_OPTSに定義する．
836
837MAKEDEP_OPTS = -R cygdrive -S
838
8396.2 コンパイルオプション
840
841ASPカーネルのコード中には，assertマクロが使われている．assertマクロは，
842NDEBUGを定義することで，オブジェクトコード中から消すことができる．カー
843ネルのデバッグが終了すれば，-DNDEBUGを指定してコンパイルした方が効率が
844よくなる．
845
846ターゲット依存部において，コンパイルオプションに-Werror（警告をエラー扱
847いする）を指定している場合がある．そのようなターゲットにおいて，アプリ
848ケーションで警告が避けられない場合には，ターゲット依存部を修正してコン
849パイルオプションを削除する必要がある．
850
851また，TOPPERS_OMIT_SYSLOGを定義してコンパイルすることで，システムログ出
852力を抑止することができる．
853
854
855７．コンフィギュレータの使い方
856
857コンフィギュレータ（cfg）は，TOPPERS新世代カーネル統合仕様書の2.12.5節
858の記述の通り，3つのパスで構成される．
859
860コンフィギュレータは，システムコンフィギュレーションファイル名をパラメー
861タに取り，以下のオプションを持つ（重要なもののみ）．
862
863 --help
864 オプションのリストと説明を表示する．
865
866 -v［--version］
867 コンフィギュレータのバージョンを表示する．
868
869 -k［--kernel］<カーネル名>
870 カーネルの名称を指定する．デフォルトはasp．
871
872 -p［--pass］<パス番号>
873 パス番号を指定する．1〜3のいずれか．
874
875 -I［--include-path］<インクルードパス名>
876 INCLUDEディレクティブにおいて，インクルードするコンフィギュレー
877 ションファイルを探すパス名を指定する．
878
879 -T［--template-file］<テンプレートファイル名>
880 テンプレートファイルの名称を指定する．パス2とパス3で有効．
881
882 --api-table <静的APIテーブルファイル名>
883 静的APIテーブルのファイル名を指定する．
884
885 --cfg1-def-table <値取得シンボルテーブルファイル名>
886 値取得シンボルテーブルのファイル名を指定する．
887
888 -r［--rom-image］<ロードモジュール名>
889 ロードモジュールをSレコードフォーマットの形に変換したファイルの
890 名称を指定する．パス3でのみ有効．
891
892 -s [--symbol-table] <シンボルファイル名>
893 ロードモジュール中の各シンボルとアドレスの対応表を含むシンボル
894 ファイルの名称を指定する．パス3でのみ有効．
895
896 --id-output-file <ID番号出力ファイル名>
897 オブジェクトのID番号の割付け結果を，指定した名前のファイルに書
898 き出す．パス2でのみ有効．
899
900 --id-input-file <ID番号入力ファイル名>
901 オブジェクトのID番号の割付けを，指定した名前のファイルから取り
902 込む．パス2でのみ有効．
903
904 --external-id
905 オブジェクトのID番号を保持する変数の定義を生成する．パス2でのみ
906 有効．
907
908 -M［--print-dependencies］<ターゲットシンボル>
909 システムコンフィギュレーションファイルの依存関係を出力する．
910 Makefile中の依存関係を生成する際に用いる．
911
912コンフィギュレータの詳細仕様については，別途PDFファイルの形で配布してい
913る「TOPPERS新世代カーネル用コンフィギュレータ仕様」を参照すること．
914
915
916８．システムサービス
917
9188.1 システムログ機能
919
920システムログ機能は，カーネル内で発生した異常事象やカーネルのトレースロ
921グ，システムサービスやアプリケーションで発生した異常事象やトレースログ
922を，ログ情報として記録するための機能である．また，記録したログ情報を取
923り出す機能も持つ．
924
925システムログ機能は，システムコンフィギュレーションファイルでsyslog.cfg
926をインクルードすることで，システムに組み込むことができる．システムログ
927出力を行うソースファイルでは，t_syslog.hをインクルードする．また，シス
928テムログ機能のその他のサービスコールを呼び出すソースファイルでは，
929syslog.hをインクルードする．
930
9318.1.1 システムログ機能の位置付け
932
933システムログ機能は，カーネル内からも呼び出すことができるため，カーネル
934より下の階層のモジュールと位置付けることができる．この意味では，他のシ
935ステムサービスとは位置付けが異なる．
936
937一方，ログ情報をシステム外部に出力するためには，シリアルインタフェース
938ドライバなど，カーネル上で動作するシステムサービスを用いる必要がある．
939そこで，ログ情報をシステム外部に出力するためのサービス（これを，システ
940ムログタスクと呼ぶ）は，システムログ機能とは分離して実装することとし，
941システムログ機能はログ情報の記録・取出しのための機能に絞っている．
942
943以上のように，システムログ機能はカーネルより下の階層のモジュールである
944が，システムログ機能の中でログ時刻を取り出すために，カーネルの機能を必
945要とする．実装上は，カーネルの内部変数を直接参照している．そのため，カー
946ネルの実行開始前や終了後は，ログ時刻は正しく記録されない．
947
9488.1.2 ログバッファへの記録と低レベル出力
949
950上述したように，ログ情報をシステムの外部に出力するためには，カーネル上
951で動作するシステムサービスを用いる必要があるため，カーネルの動作を継続
952できないような重大な異常事象が起こった場合には，ログ情報を出力できなく
953なる．また，これらのシステムサービス自身をデバッグする場合にも，ログ情
954報の出力ができない．
955
956そこで，カーネル上で動作するシステムサービスが使えない場合にでもログ情
957報を出力するために，低レベル出力機能を用意する．低レベル出力機能は，ター
958ゲット依存に用意する低レベルの文字出力関数（target_fput_log）を用いてロ
959グ情報を出力する機能である．低レベルの文字出力関数は，ターゲット依存部
960で用意することとしているが，最終製品に組み込まれる場合などでは，文字を
961出力する方法がない状況も考えられる．そのような場合，低レベルの文字出力
962関数に送られた文字は，メモリ上に残しておくか，捨ててしまうしかない．
963
964ログ情報を，ログバッファへ記録するか低レベル出力機能を用いて出力するか
965の設定は，システムログ機能のサービスコール（syslog_msk_log）によって行
966うことができる．syslog_msk_logの使い方については後述する．デフォルトで
967は（システムログタスクを動作させず，syslog_msk_logも呼び出さない場合），
968すべてのログ情報を低レベル出力機能を用いて出力し，ログバッファには記録
969しない．
970
971低レベル出力機能を用いると，ログメッセージの作成処理（printf相当の処理）
972と低レベルの文字出力処理をカーネル内で行うために，カーネルの応答性が悪
973くなることに注意しなければならない．特に，低レベルの文字出力処理はデバ
974イスをポーリングする形で実装するのが通常で，その場合には，カーネルの応
975答性は実用的と言えない程に悪くなる．
976
9778.1.3 ログ情報の種別
978
979システムログ機能は，ログ情報に以下の種別を設けている．
980
981 LOG_TYPE_COMMENT コメント
982 LOG_TYPE_ASSERT アサーションの失敗
983 LOG_TYPE_INH 割込みハンドラ
984 LOG_TYPE_ISR 割込みサービスルーチン
985 LOG_TYPE_CYC 周期ハンドラ
986 LOG_TYPE_ALM アラームハンドラ
987 LOG_TYPE_OVR オーバランハンドラ
988 LOG_TYPE_EXC CPU例外ハンドラ
989 LOG_TYPE_TEX タスク例外処理ルーチン
990 LOG_TYPE_TSKSTAT タスク状態変化
991 LOG_TYPE_DSP ディスパッチャ
992 LOG_TYPE_SVC サービスコール
993
994ログ情報の種別の中で，LOG_TYPE_COMMENTとLOG_TYPE_ASSERT以外は，カーネル
995のトレースログに用いるためのものであるが，使用するかどうかはターゲット
996依存部に任されている．
997
9988.1.4 ログ情報の重要度
999
1000システムログ機能は，ログ情報を出力する際に指定する重要度に基づいて，実
1001際に出力するログ情報を動的に設定することができる．これは，UNIXのシステ
1002ムログ機能をまねたもので，ログの重要度の種類や指定方法もUNIXのAPIを参考
1003にしている．また，低レベル出力機能を用いて出力するログ情報も，重要度に
1004基づいて動的に設定することができる．
1005
1006具体的には，ログの重要度として次の8段階を用意している．
1007
1008 LOG_EMERG カーネルの動作を継続できないエラー
1009 LOG_ALERT
1010 LOG_CRIT
1011 LOG_ERROR 重要性の低いシステムエラー
1012 LOG_WARNING 警告メッセージ．システムは安全に継続動作できる
1013 LOG_NOTICE
1014 LOG_INFO
1015 LOG_DEBUG デバッグのためのメッセージ
1016
1017どの重要度のログ情報をログバッファに記録するかと，どの重要度のログ情報
1018を低レベル出力機能を用いて出力するかは，システムログ機能のサービスコー
1019ル（syslog_msk_log）によって設定することができる．
1020
10218.1.5 ログ情報のデータ構造
1022
1023ログ情報を格納するためのデータ型として，SYSLOG構造体を用意している．
1024SYSLOG構造体には，ログ情報の種別（logtypeフィールド），ログ時刻
1025（logtimフィールド），その他のログ情報（loginfoフィールド）が含まれる．
1026
1027SYSLOG構造体に格納されたログ情報を出力する場合には，ログ時刻は出力関数
1028（syslog_wri_log）によって書き込まれるため，出力関数を呼ぶ側で書き込む
1029必要はない．
1030
10318.1.6 システムログ機能のサービスコール
1032
1033システムログ機能の提供するサービスコールは次の通りである．これらのサー
1034ビスコールを呼び出すソースファイルでは，syslog.hをインクルードする必要
1035がある．
1036
1037(1) ER syslog_wri_log(uint_t prio, const SYSLOG *p_syslog)
1038
1039システムログ機能に，p_syslogで指定されるログ情報を，prioで指定される重
1040要度で出力する（ログバッファへ記録するか低レベル出力機能を用いて出力す
1041る）．
1042
1043プロトタイプ宣言において，*p_syslogにconst指定がされているが，実際には，
1044この関数の中で，*p_syslogのlogtimフィールドにシステム時刻を書き込んでい
1045る．
1046
1047(2) ER_UINT syslog_rea_log(SYSLOG *p_syslog)
1048
1049ログバッファからログ情報を1つ取り出す．ログバッファが空の時はE_OBJ，そ
1050うでない場合は，ログバッファのオーバフローにより失われたログ情報の数
1051（ログ情報が失われていない場合は0）を返す．システムログタスクが用いるこ
1052とを想定している．
1053
1054(3) ER syslog_msk_log(uint_t logmask, uint_t lowmask)
1055
1056ログバッファに記録すべきログ情報の重要度の示すビットマップ（logmask）と，
1057低レベル出力機能を用いて出力すべきログ情報の重要度を示すビットマップ
1058（lowmask）を設定する．ビットマップを作るためのマクロとして，LOG_MASKと
1059LOG_UPTOを用意している．
1060
1061(4) ER_UINT syslog_ref_log(T_SYSLOG_RLOG *pk_rlog)
1062
1063システムログ機能の状態を参照する．具体的には，ログバッファに記録されて
1064いるログ情報の数（T_SYSLOG_RLOG構造体のcountフィールド），ログバッファ
1065のオーバフローにより失われたログ情報の数（lostフィールド），ログバッファ
1066に記録すべきログ情報の重要度の示すビットマップ（logmaskフィールド），低
1067レベル出力機能を用いて出力すべきログ情報の重要度を示すビットマップ
1068（lowmaskフィールド）を参照することができる．
1069
10708.1.7 システムログ機能のためのライブラリ関数とマクロ
1071
1072システムログ出力のためのライブラリ関数とマクロは次の通りである．これら
1073だけを呼び出すソースファイルでは，t_syslog.hをインクルードすればよい．
1074
1075(1) void _syslog_n(uint_t prio, uint_t type, intptr_t arg1, ..., intptr_t argn)
1076 ※ nは0〜6のいずれか．
1077
1078ログ種別がtype，パラメータがarg1〜argnのログ情報を，重要度prioで出力す
1079るための関数．
1080
1081(2) void syslog_n(uint_t prio, const char *format, arg1, ..., argn)
1082 ※ nは0〜5のいずれか．
1083
1084format文字列およびそれに続く引数から作成されるメッセージを，ログ種別が
1085LOG_TYPE_COMMENTのログ情報として，重要度prioで出力するためのマクロ．
1086
1087formatはメッセージのフォーマット記述，arg1〜argnはフォーマット記述中で
1088参照される値で，printfのフォーマット記述のサブセットとなっている．arg1〜
1089argnは，このマクロ中でintptr_t型にキャストされるため，intptr_t型に型変
1090換できる任意の型を渡すことができ，型チェックはされない．formatおよび
1091arg1〜argnには，次の制限がある．
1092
1093・formatのフォーマット記述は，定数文字列を渡すことを想定しており，この
1094マクロ処理を終えた後も変化してはならない．
1095
1096・format中に使えるフォーマット指定は次の通り．
1097
1098 %d 引数をint_t型とみなし，10進数で表示
1099 %u 引数をuint_t型とみなし，10進数で表示
1100 %x 引数をuint_t型とみなし，16進数（英文字は小文字）で表示
1101 %X 引数をuint_t型とみなし，16進数（英文字は大文字）で表示
1102 %p 引数をポインタとみなし，16進数（英文字は小文字）で表示
1103 %c 引数を文字コードとみなし，文字を表示
1104 %s 引数を文字列を示すポインタとみなし，文字列を表示
1105 %% '%'を表示（引数は取らない）
1106
1107%d, %u, %x, %Xにおいては，'%'の直後に表示桁数を指定する10進数値を記述す
1108ることができる．その場合，表示すべき文字列が指定した桁数に満たない場合
1109には，指定した桁数内に右詰めで表示する．10進数値が'0'で始まる場合には，
1110その間に'0'を埋める．
1111
1112また，intptr_t型のサイズがlong型のサイズ以上である環境においては，次の
1113フォーマット指定も使用することができる．この他のフォーマット指定に'l'
1114を付加した場合には無視する（%lcと%lsには対応していない）．
1115
1116 %ld 引数をlong_t型とみなし，10進数で表示
1117 %lu 引数をulong_t型とみなし，10進数で表示
1118 %lx 引数をulong_t型とみなし，16進数（英文字は小文字）で表示
1119 %lX 引数をulong_t型とみなし，16進数（英文字は大文字）で表示
1120
1121・arg1〜argnにポインタを渡す場合（%sに対応する引数の場合）に，ポインタ
1122の指すデータは，このマクロ処理を終えた後も変化してはならない．定数文字
1123列を渡すことを想定している．
1124
1125(3) void syslog(uint_t prio, const char *format, ...)
1126
1127format文字列およびそれに続く引数から作成されるメッセージを，ログ種別が
1128LOG_TYPE_COMMENTのログ情報として，重要度prioで出力するための関数で，引
1129数の数を可変にしたもの．formatに続く引数は最大5個まで．formatおよびそれ
1130に続く引数には，syslog_nと同様の制限がある．
1131
1132このライブラリ関数は，可変数引数を処理するために内部で文字列をスキャン
1133する．そのため，実行時間が長くなる可能性があり，割込み禁止状態で呼び出
1134すべきではない．主にアプリケーションプログラムが用いることを想定してい
1135る．
1136
1137(4) UINT LOG_MASK(UINT prio)
1138
1139重要度prioのみセットされたビットマップを作るマクロ．syslog_msk_logに渡
1140す引数を作るために用いる．
1141
1142(5) UINT LOG_UPTO(UINT prio)
1143
1144重要度prio以上の重要度がすべてセットされたビットマップを作るマクロ．
1145syslog_msk_logに渡す引数を作るために用いる．
1146
11478.1.8 システムログ機能のその他のサービス
1148
1149システムログ機能は，前記のサービスコール等に加えて，初期化処理のための
1150関数を持つ．
1151
1152(1) void syslog_initialize(intptr_t exinf)
1153
1154システムログ機能を初期化する．ログバッファにログ情報が記録されている場
1155合には，消去される．syslog.cfgによって，カーネルに初期化ルーチンとして
1156登録される．exinfは無視される．
1157
11588.2 シリアルインタフェースドライバ
1159
1160シリアルインタフェースドライバは，シリアルポートを扱うためのドライバで
1161ある．
1162
1163シリアルインタフェースドライバは，システムコンフィギュレーションファイ
1164ルでserial.cfgをインクルードすることで，システムに組み込むことができる．
1165シリアルインタフェースドライバを呼び出すソースファイルでは，serial.hを
1166インクルードする．
1167
1168シリアルインタフェースドライバは，ポート毎にセマフォを2個ずつ使用する．
1169セマフォを生成する静的APIは，serial.cfgに含まれている．
1170
11718.2.1 シリアルインタフェースドライバのサービスコール
1172
1173シリアルインタフェースドライバを呼び出すサービスコールの仕様は次の通り
1174である．この中で，シリアルポートのID番号（portid）の解釈はターゲット依
1175存となる．
1176
1177これらのサービスコールは，非タスクコンテキストから呼び出すことはできな
1178い．また，serial_rea_datとserial_wri_datは，ディスパッチ保留状態で呼び
1179出すことはできない．いずれも，呼び出した場合にはE_CTXエラーとなる．
1180
1181(1) ER serial_opn_por(ID portid)
1182
1183portidで指定されたシリアルポートをオープンし，受信／送信が可能な状態に
1184する．
1185
1186(2) ER serial_cls_por(ID portid)
1187
1188portidで指定されたシリアルポートをクローズする．
1189
1190(3) ER_UINT serial_rea_dat(ID portid, char_t *buf, uint_t len)
1191
1192portidで指定されたシリアルポートから，lenバイトの文字列を受信し，bufか
1193らの領域に入れる．lenバイト受信するまで，待ち状態となる．受信した文字数
1194またはエラーコードを返す．
1195
1196(4) ER_UINT serial_wri_dat(ID portid, const char_t *buf, uint_t len)
1197
1198portidで指定されたシリアルポートに，bufからのlenバイトの文字列を送信す
1199る．lenバイト送信バッファに入れるまで，待ち状態となる．送信した文字数ま
1200たはエラーコードを返す．
1201
1202(5) ER serial_ctl_por(ID portid, uint_t ioctl)
1203
1204portidで指定されたシリアルポートの制御情報を，ioctlで示される値に設定す
1205る．
1206
1207ioctlには，以下の制御情報を表す定数を，ビット毎に論理和をとったものを
1208指定する．
1209
1210 IOCTL_ECHO（エコーバックモード）
1211 このビットを設定すると，シリアルインタフェースドライバがエコー
1212 バックを行う．具体的には，バッファから文字を取り出す度に，その
1213 文字を書き出す．
1214
1215 IOCTL_CRLF（改行モード）
1216 LF（line feed）を書き出すと，CR（carriage return）＋LFに変換し
1217 て書き出す．
1218
1219 IOCTL_FCSND（送信フロー制御）
1220 文字を送信する処理に対して，XON/XOFFによるフロー制御を行う．
1221 すなわち，STOP（コントロール-S）を受信すると送信を停止し，
1222 START（コントロール-Q）を受信すると送信を再開する．
1223
1224 IOCTL_FCANY（送信フロー制御で任意の文字で送信再開）
1225 IOCTL_FCSNDを指定している時に，送信停止中に受信した任意の文字
1226 で送信を再開する．
1227
1228 IOCTL_FCRCV（受信フロー制御）
1229 文字を受信する処理に対して，XON/XOFFによるフロー制御を行う．
1230 すなわち，受信バッファの残り領域が少なくなるとSTOP（コントロー
1231 ル-S）を送出し，残り領域が増えればSTART（コントロール-Q）を送
1232 出する．
1233
1234なお，オープン直後のデフォルトの設定値は(IOCTL_ECHO | IOCTL_CRLF |
1235IOCTL_FCSND | IOCTL_FCRCV)である．
1236
1237(6) ER serial_ref_por(ID portid, T_SERIAL_RPOR *pk_rpor)
1238
1239portidで指定されたシリアルポートの状態を参照し，pk_rporで指定されるパケッ
1240トに返す．パケット中のreacntには受信バッファ中の文字数を，wricntには送
1241信バッファ中の文字数を返す．
1242
12438.2.2 シリアルインタフェースドライバのその他のサービス
1244
1245シリアルインタフェースドライバは，前記のサービスコールに加えて，初期化
1246処理と未送信文字の取出し処理を持つ．初期化処理は，カーネルに初期化ルー
1247チンとして登録する．また，ターゲット依存で，初期化処理，終了処理，割込
1248みサービスルーチンを持つ．これらの登録処理はserial.cfgに含まれる．
1249
1250(1) void serial_initialize(intptr_t exinf)
1251
1252シリアルインタフェースドライバを初期化する．カーネルに初期化ルーチンと
1253して登録する．exinfは無視する．
1254
1255(2) bool_t serial_get_chr(ID portid, char_t *p_c)
1256
1257portidで指定されたシリアルポートの送信バッファ中の文字を，p_cの指す番地
1258に取り出し，trueを返す関数．文字がなかった時には，falseを返す．終了処理
1259ルーチン中で呼び出すことを想定している．
1260
12618.3 システムログタスク
1262
1263システムログタスクは，システムログ機能からログ情報を取り出し，それをシ
1264ステムの外部に出力するためのサービスである．
1265
1266ASPカーネルのリリースパッケージに含まれるシステムログタスクは，シリアル
1267ポートにログ情報を文字列の形で出力するもので，システムログタスクの一例
1268という位置付けで提供している．
1269
1270このシステムログタスクは，システムコンフィギュレーションファイルで
1271logtask.cfgをインクルードすることで，システムに組み込むことができる．シ
1272ステムログタスクのサービスを呼び出すソースファイルでは，logtask.hをイン
1273クルードする．
1274
1275システムログタスクが実行開始されると，重要度がLOG_EMERGのログ情報を低レ
1276ベル出力機能を用いて出力し，重要度がLOG_NOTICEかそれより高いログ情報を
1277ログバッファに記録するように，システムログ機能の設定が変更される．
1278
12798.3.1 システムログタスクのサービスコール
1280
1281システムログタスクのサービスを呼び出すサービスコールの仕様は次の通りで
1282ある．
1283
1284(1) ER logtask_flush(uint_t count)
1285
1286システムログ機能のログバッファ中のログ情報の数がcount以下になるまで待つ．
1287countが0の場合には，シリアルインタフェースドライバの送信バッファが空に
1288なるのも待つ．
1289
12908.3.2 システムログタスクのその他のサービス
1291
1292システムログタスクは，前記のサービスコールに加えて，メイン処理と終了処
1293理を持つ．メイン処理はタスクとして，終了処理は終了処理ルーチンとして登
1294録する．これらの登録処理はlogtask.cfgに含まれる．
1295
1296(1) void logtask_main(intptr_t exinf)
1297
1298システムログタスクのメイン処理．exinfには，ログ情報を出力するシリアルポー
1299トのID番号を渡す．
1300
1301(2) void logtask_terminate(intptr_t exinf)
1302
1303システムログタスクの終了処理．シリアルインタフェースドライバの送信バッ
1304ファに蓄積されたデータと，ログバッファに記録されたログ情報を，低レベル
1305出力機能を用いて出力する．出力すべきログ情報がある場合には，それを出力
1306する前に，"-- buffered messages --"という文字列を出力する．exinfは無視
1307する．
1308
1309この関数を終了処理ルーチンとして登録することで，カーネル終了時点で未出
1310力のログ情報のほとんどを出力することができる．ただし，未出力のログ情報
1311の内，システムログタスクのメイン処理が，ログバッファから取り出したが，
1312まだシリアルインタフェースドライバに送信していない情報は，この関数では
1313出力できない．
1314
13158.4 カーネル起動メッセージの出力
1316
1317カーネル起動メッセージの出力は，カーネルの起動時に，カーネルの名称やバー
1318ジョン番号，著作権表示などを出力するための機能である．
1319
1320カーネル起動メッセージの出力は，システムコンフィギュレーションファイル
1321でbanner.cfgをインクルードすることで，システムに組み込むことができる．
1322
1323カーネル起動メッセージの出力は，次の関数で構成される．
1324
1325(1) void print_banner(intptr_t exinf)
1326
1327システムログ機能を用いて，カーネル起動メッセージを出力する．banner.cfg
1328によって，カーネルに初期化ルーチンとして登録される．exinfは無視される．
1329
1330
1331９．サポートライブラリ
1332
1333サポートライブラリは，アプリケーションやシステムサービスを作成するため
1334に利用できるライブラリ関数群である．
1335
13369.1 基本的なライブラリ関数
1337
1338基本的なライブラリ関数を用いる場合には，t_stdlib.hをインクルードし，必
1339要に応じてstrerror.cとt_perror.cをコンパイル・リンクする．
1340
1341(1) const char *itron_strerror(ER ercd)
1342
1343ercdで示されるエラーコードに対応するメインエラーコードの文字列を返す．
1344
1345(2) void t_perror(uint_t prio, const char *file, int_t line,
1346 const char *expr, ER ercd);
1347
1348サービスコールがエラーを返した場合に用いることを想定した関数で，ファイ
1349ル名，行番号，メインエラーコード等を，重要度prioで，システムログ機能を
1350用いて出力する．
1351
13529.2 キュー操作ライブラリ関数
1353
1354キュー操作ライブラリは，キューヘッダを含むリング構造のダブルリンクキュー
1355を扱うライブラリである．キューヘッダの次エントリはキューの先頭のエント
1356リ，前エントリはキューの末尾のエントリとする．また，キューの先頭のエン
1357トリの前エントリと，キューの末尾のエントリの次エントリは，キューヘッダ
1358とする．空のキューは，次エントリ，前エントリとも自分自身を指すキューヘッ
1359ダであらわす．
1360
1361キュー操作ライブラリ関数を用いる場合には，queue.hをインクルードする．
1362
1363キューヘッダとエントリのためのデータ構造として，QUEUE構造体を用いる．
1364QUEUE構造体の定義は次の通り．
1365
1366 typedef struct queue {
1367 struct queue *p_next; /* 次エントリへのポインタ */
1368 struct queue *p_prev; /* 前エントリへのポインタ */
1369 } QUEUE;
1370
1371キュー操作のために用意している関数は次の通り．
1372
1373(1) void queue_initialize(QUEUE *p_queue);
1374
1375キューを初期化する．p_queueにはキューヘッダを指定する．
1376
1377(2) void queue_insert_prev(QUEUE *p_queue, QUEUE *p_entry);
1378
1379p_queueで指定するエントリの前に，p_entryで指定するエントリを挿入する．
1380p_queueにキューヘッダを指定した場合には，キューの末尾にp_entryで指定す
1381るエントリを挿入することになる．
1382
1383(3) void queue_insert_next(QUEUE *p_queue, QUEUE *p_entry);
1384
1385p_queueで指定するエントリの次に，p_entryで指定するエントリを挿入する．
1386p_queueにキューヘッダを指定した場合には，キューの先頭にp_entryで指定す
1387るエントリを挿入することになる．
1388
1389(4) void queue_delete(QUEUE *p_entry);
1390
1391p_entryで指定するエントリを，キューから削除する．
1392
1393(5) QUEUE *queue_delete_next(QUEUE *p_queue);
1394
1395p_queueで指定するエントリの次のエントリをキューから削除し，削除したエン
1396トリを返す．p_queueにキューヘッダを指定した場合には，キューの先頭のエン
1397トリを取り出すことになる．p_queueに空のキューを指定して呼び出してはなら
1398ない．
1399
1400(6) bool_t queue_empty(QUEUE *p_queue);
1401
1402キューが空の場合にはtrue，そうでない場合にはfalseを返す．p_queueには
1403キューヘッダを指定する．
1404
14059.3 システムログ出力用ライブラリ関数
1406
1407システムログ出力用ライブラリ関数は，ログ情報をフォーマット出力するため
1408に，システムログタスクおよびシステムログ機能で用いるための関数群である．
1409
1410システムログ出力用ライブラリ関数を用いる場合には，log_output.hをインク
1411ルードし，log_output.cをコンパイル・リンクする．
1412
1413(1) void syslog_printf(const char *format, const intptr_t *args,
1414 void (*putc)(char_t))
1415
1416formatで指定されるフォーマット記述とp_argsで指定される引数列から作成し
1417たメッセージを，1文字出力関数putcを用いて出力する．
1418
1419(2) void syslog_print(const SYSLOG *p_sys, void (*putc)(char_t))
1420
1421p_syslogで指定されるログ情報を文字列に直し，1文字出力関数putcを用いて出
1422力する．
1423
1424(3) void syslog_lostmsg(uint_t lost, void (*putc)(char_t))
1425
1426lost個のログ情報が失われた旨のメッセージを，1文字出力関数putcを用いて出
1427力する．
1428
14299.4 実行時間分布集計モジュール
1430
1431実行時間分布集計モジュールは，システムのリアルタイム性能を評価するため
1432に，プログラム区間の実行時間を計測し，その分布を集計・表示するためのラ
1433イブラリ関数群である．
1434
1435実行時間分布集計モジュールを用いる場合には，histogram.hをインクルードし，
1436histogram.cをコンパイル・リンクする．
1437
1438実行時間分布集計モジュールは，複数のプログラム区間の実行時間を計測・集
1439計・表示することができる．プログラム区間毎に，実行時間分布を記録するた
1440めのデータ構造を持つ．どのデータ構造を用いるかを，ID番号（histid）で指
1441定する．使用できるデータ構造の数は，TNUM_HISTで定義される．すなわち，
1442ID番号として，1〜TNUM_HISTを指定することができる．TNUM_HISTは，デフォル
1443ト値がhistgram.cの中で定義されており，コンパイルオプションやターゲット
1444依存部（target_test.hまたはそこからインクルードされるファイル）により変
1445更することができる．
1446
1447ターゲット依存部で設定を変更していない場合，実行時間分布集計モジュール
1448は，カーネルの性能評価用システム時刻を参照する機能（get_utm）を用いて実
1449行時間を計測する．そのため，実行時間はマイクロ秒単位で記録される（精度
1450はターゲット依存）．また，記録される時間には，計測のためのオーバヘッド
1451（get_utmの実行時間＋α）が含まれる．
1452
1453ターゲット依存部で設定を変更している場合の仕様については，ターゲット依
1454存部のユーザーズマニュアルを参照すること．
1455
1456(1) void init_hist(ID histid, uint_t maxval, uint_t *hist)
1457
1458histidで指定されたデータ構造を初期化する．maxvalには記録する最大時間を，
1459histには記録領域の先頭番地を指定する．histで始まる記憶領域は，要素数が
1460maxvalに指定した値+1のuint_t型の配列として確保する．例えば，maxvalに
14611000を指定する場合には，histには要素数が1001のuint_t型の配列の先頭番地
1462を渡す．
1463
1464(2) void begin_measure(ID histid)
1465
1466実行時間を計測するプログラム区間の直前に呼び出す関数．histidで指定され
1467たデータ構造に，現在のシステム時刻を記録する．
1468
1469(3) void end_measure(ID histid)
1470
1471実行時間を計測するプログラム区間の直後に呼び出す関数．現在のシステム時
1472刻と，histidで指定されたデータ構造に記録された開始時刻から，プログラム
1473区間の実行時間を求め，その結果を記録する．
1474
1475(4) void print_hist(ID histid)
1476
1477システムログ機能を用いて，実行時間分布の計測結果を出力する．
1478
1479
1480１０．テストプログラム
1481
1482テストプログラムは，カーネルの機能テストおよび性能評価を行うためのプロ
1483グラム群である．
1484
148510.1 テストプログラム用ライブラリ
1486
1487テストプログラム用ライブラリは，プログラム中のチェックポイントが正しい
1488順序で実行されたことなど，プログラムが正しく動作していることをチェック
1489するための関数群である．プログラムが正しく動作していないことを検出した
1490場合には，プログラムを終了させる．
1491
1492このライブラリ中でプログラムを終了させる時には，その時点で未出力のログ
1493情報等を出力しようとするが，一部の情報が抜ける場合がある．詳しくは，
1494「8.3.2 システムログタスクのその他のサービス」の節の(2)を参照すること．
1495
1496テストプログラム用ライブラリ関数を用いる場合には，test_lib.hをインクルー
1497ドし，test_lib.cをコンパイル・リンクする．
1498
1499(1) void check_point(uint_t count)
1500
1501チェックポイントを通過する際に呼び出す関数．countには，何番目のチェック
1502ポイントであるかを指定する（最初のチェックポイントでは1を指定する）．
1503countの値が，最初のチェックポイントにおいては1でない場合に，それ以降の
1504チェックポイントにおいては，前のチェックポイント通過時にcountに指定した
1505値に1を加えた値でない場合に，プログラムが正しく動作していないと見なし，
1506プログラムを終了させる．
1507
1508(2) void check_finish(uint_t count)
1509
1510最後のチェックポイントに到達した際に呼び出す関数．countには，何番目の
1511チェックポイントであるかを指定する（最初のチェックポイントでは1を指定す
1512る）．countの値が，前のチェックポイント通過時にcountに指定した値に1を加
1513えた値でない場合に，プログラムが正しく動作していないと見なす．この関数
1514は，プログラムが正しく動作している／いないに関わらず，プログラムを終了
1515させる．
1516
1517(3) void check_assert(bool_t exp)
1518
1519expが真であることをチェックしたい場合に呼び出す関数．expが偽である場合
1520に，プログラムが正しく動作していないと見なし，プログラムを終了させる．
1521
1522(4) void check_ercd(ER ercd, ER expected_ercd)
1523
1524ercdがexpected_ercdに一致していることをチェックしたい場合に呼び出す関数．
1525ercdがexpected_ercdに一致していない場合に，プログラムが正しく動作してい
1526ないと見なし，プログラムを終了させる．
1527
1528(5) void check_state(bool_t ctx, bool_t loc, PRI ipm,
1529 bool_t dsp, bool_t dpn, bool_t tex)
1530
1531タスクコンテキストにおいて，システム状態が期待したものになっているか
1532チェックしたい時に呼び出す関数．ctx，loc，dsp，dpn，texにはそれぞれ
1533sns_ctx()，sns_loc()，sns_dsp()，sns_dpn()，sns_tex()の返値として期待さ
1534れる値を，ipmにはget_ipm()で参照できる割込み優先度マスクとして期待され
1535る値を指定する．この内のいずれかが期待される値と一致していない場合に，
1536プログラムが正しく動作していないと見なし，プログラムを終了させる．
1537
1538(6) void check_state_i(bool_t ctx, bool_t loc,
1539 bool_t dsp, bool_t dpn, bool_t tex)
1540
1541非タスクコンテキストにおいて，システム状態が期待したものになっているか
1542チェックしたい時に呼び出す関数．ctx，loc，dsp，dpn，texにはそれぞれ
1543sns_ctx()，sns_loc()，sns_dsp()，sns_dpn()，sns_tex()の返値として期待さ
1544れる値を指定する．この内のいずれかが期待される値と一致していない場合に，
1545プログラムが正しく動作していないと見なし，プログラムを終了させる．
1546
1547(7) void set_bit_func(BIT_FUNC bit_func)
1548
1549チェックポイントにおいて呼び出す自己診断関数を設定するための関数．
1550
1551(8) void syslog_flush(void)
1552
1553システムログ機能に記録されたログ情報を，低レベル出力機能に用いる文字出
1554力関数により出力する．
1555
1556(9) void test_finish(void)
1557
1558プログラムを終了させる関数．チェックポイントを使用しない場合に，この関
1559数を用いる．
1560
156110.2 カーネルの整合性検査
1562
1563チェックポイントにおいて呼び出す自己診断に使うためのプログラムとして，
1564カーネルの整合性検査を用意している．カーネルの整合性検査は，カーネル内
1565の各データ構造の一貫性を検査する（現時点では未完成）．
1566
1567カーネルの整合性検査を用いる場合には，bit_kernel.cをコンパイル・リンク
1568する．
1569
1570(1) ER bit_kernel(void)
1571
1572カーネル内の各データ構造の一貫性を検査し，一貫性が確認できた場合にE_OK，
1573できなかった場合にE_SYSエラーを返す関数．E_SYSエラーを返す際のサブエラー
1574コードとして，一貫性が確認できなかった項目を示すコードを返す．
1575
157610.3 機能テストプログラム
1577
1578testディレクトリに置かれた"test"で始まるプログラムは，カーネルの機能テ
1579ストを行うためのプログラムである．
1580
1581機能テストプログラムはテストプログラム用ライブラリを使用しているため，
1582構築する場合には，MakefileのAPPL_COBJSに，test_lib.oを追加する必要があ
1583る．コンフィギュレーションスクリプトを使用する場合には，-Uオプションで
1584test_lib.oを指定する．具体的には，次のコマンドを実行すればよい（構築用
1585のディレクトリが，ASPカーネルのソースファイルを展開したディレクトリの直
1586下にあると仮定している）．
1587
1588 % perl ../configure -T <ターゲット略称> -A <機能テストプログラム名> \
1589 -a ../test -U test_lib.o
1590
1591ただし，CPU例外処理のテスト(1)〜(13)は，同一のシステムコンフィギュレー
1592ションを共用しているため，test_cpuexc.cfgを次のようにコピーしておく必要
1593がある．
1594
1595 % cp ../test/test_cpuexc.cfg test_cpuexc<テスト番号>.cfg
1596
1597現バージョンで用意している機能テストプログラムは次の通り．
1598
1599(1) test_cpuexc1 CPU例外処理のテスト(1)
1600(2) test_cpuexc2 CPU例外処理のテスト(2)
1601(3) test_cpuexc3 CPU例外処理のテスト(3)
1602(4) test_cpuexc4 CPU例外処理のテスト(4)
1603(5) test_cpuexc5 CPU例外処理のテスト(5)
1604(6) test_cpuexc6 CPU例外処理のテスト(6)
1605(7) test_cpuexc7 CPU例外処理のテスト(7)
1606(8) test_cpuexc8 CPU例外処理のテスト(8)
1607(9) test_cpuexc9 CPU例外処理のテスト(9)
1608(10) test_cpuexc10 CPU例外処理のテスト(10)
1609(11) test_cpuexc11 CPU例外処理のテスト(11)
1610(12) test_cpuexc12 CPU例外処理のテスト(12)
1611(13) test_cpuexc13 CPU例外処理のテスト(13)
1612(14) test_dlynse sil_dly_nseに関するテスト
1613(15) test_sem1 セマフォ機能のテスト(1)
1614(16) test_sem2 セマフォ機能のテスト(2)
1615(17) test_sysstat1 システム状態に関するテスト(1)
1616(18) test_task1 タスク管理モジュールのテスト(1)
1617(19) test_tex1 タスク例外処理に関するテスト(1)
1618(20) test_tex2 タスク例外処理に関するテスト(2)
1619(21) test_utm1 get_utmに関するテスト(1)
1620
1621CPU例外処理のテストプログラムの一部は，CPU例外ハンドラからリターンした
1622場合に，CPU例外を発生させた命令の次から実行が継続されることを前提に作成
1623されている．この前提が成り立たない場合には，テストプログラムのターゲッ
1624ト依存定義において，CANNOT_RETURN_CPUEXCをマクロ定義することが必要であ
1625る．詳しくは，「ターゲット依存部 ポーティングガイド」を参照すること．
1626
162710.4 性能評価プログラム
1628
1629testディレクトリに置かれた"perf"で始まるプログラムは，カーネルの性能評
1630価を行うためのプログラムである．
1631
1632性能評価プログラムは，計測対象となる処理を繰り返し実行し，その実行時間
1633を計測して，実行時間分布を表示する．
1634
1635計測した実行時間には，時間計測のオーバヘッド（時間計測処理の実行にかか
1636る時間）が含まれる．計測対象の処理の正味の実行時間を求めるためには，計
1637測された時間から，時間計測のオーバヘッドを計測するためのプログラム
1638（perf0）で計測された時間を減算する必要がある．
1639
1640また，実行時間の計測は，別に記述がない限り割込みを許可したまま行うため，
1641割込みハンドラ（少なくとも，タイマ割込みハンドラ）の処理時間が含まれた
1642実行結果が計測される．
1643
1644カーネルの性能評価にあたっては，ハードウェア（特にキャッシュ）の設定に
1645留意する必要がある．
1646
1647性能評価プログラムはテストプログラム用ライブラリと実行時間分布集計モ
1648ジュールを使用しているため，構築する場合には，MakefileのAPPL_COBJSに，
1649test_lib.oとhistogram.oを追加する必要がある．コンフィギュレーションスク
1650リプトを使用する場合には，-Uオプションでtest_lib.oとhistgram.oを指定す
1651る．具体的には，次のコマンドを実行すればよい（構築用のディレクトリが，
1652ASPカーネルのソースファイルを展開したディレクトリの直下にあると仮定して
1653いる）．
1654
1655 % perl ../configure -T <ターゲット略称> -A <性能評価プログラム名> \
1656 -a ../test -U "test_lib.o histogram.o"
1657
1658現バージョンで用意している性能評価プログラムは次の通り．
1659
1660(1) perf0 時間計測のオーバヘッドの評価
1661
1662時間計測のオーバヘッドを計測するためのプログラム．具体的には，空のプロ
1663グラム（begin_mearsureとend_measureを続けて呼び出すプログラム）の実行時
1664間を計測する．
1665
1666他の性能評価プログラムで計測された時間から，このプログラムで計測された
1667時間を減算した時間が，計測対象の処理の正味の実行時間である．
1668
1669(2) perf1 slp_tsk，wup_tskによるタスク切換え時間の評価
1670
1671slp_tsk，wup_tskによるタスク切換え時間を計測するためのプログラム．具体
1672的には，高い優先度のタスクが起床待ち状態である時に，低い優先度のタスク
1673がwup_tskにより高い優先度のタスクを起床し，高い優先度のタスクに切り換わ
1674るまでの時間と，高い優先度のタスクがslp_tskにより起床待ち状態となり，低
1675い優先度のタスクに切り換わるまでの時間を計測する．
1676
1677(3) perf2 snd_pdqの処理時間の評価
1678
1679優先度データキューに蓄積されているデータの数により，snd_pdqの処理時間が
1680どのように変化するかを計測するためのプログラム．具体的には，優先度デー
1681タキュー中に高い優先度のデータがn個蓄積されている時に，snd_dtqにより低
1682い優先度のデータを入れるのにかかる時間を計測する．nを0，10，20，30，40，
168350，100，200，300と変化させて計測する．
1684
1685(4) perf3 set_flgの処理時間の評価
1686
1687待ち解除するタスクの数により，set_flgの処理時間がどのように変化するかを
1688計測するためのプログラム．具体的には，TA_WMUL属性のイベントフラグに対し
1689て，n個のタスクが待っている時に，set_flgによりそのすべてを待ち解除する
1690のにかかる時間を計測する．nを0，1，2，3，4，5，10，20と変化させて計測す
1691る．
1692
1693(5) perf4 act_tsk，iact_tskの処理時間とタスク切換え時間の評価
1694
1695act_tsk，iact_tskの処理時間とタスク切換え時間を計測するためのプログラム．
1696具体的には，(1) タスク切換えを起こさないact_tskの処理時間，(2) タスク切
1697換えを起こすact_tskの処理時間（タスク切換え時間を含む），(3) タスク切換
1698えを起こすiact_tskの処理時間（タスク切換え時間とタイマ割込み中で実行さ
1699れるシステム時刻の更新処理時間を含む）の3つの時間を計測する．
1700
1701１１．使用上の注意とヒント
1702
170311.1 タイマドライバの組込み
1704
1705タイマドライバをシステムに組み込むために，システムコンフィギュレーショ
1706ンファイルの先頭でtarget_timer.cfgをインクルードする必要がある．
1707
170811.2 assertマクロの処理
1709
1710ASPカーネルのコード中には，assertマクロが使われている．assertマクロの定
1711義はt_stddef.hに含まれ，assertが失敗した場合の最後の処理（通常は，プロ
1712グラムを停止させる処理）は，ターゲット依存部のTOPPERS_assert_abortで決
1713定される．
1714
1715assertが失敗した場合，システム開発中はデバッガに落とすのが望ましいが，
1716システム稼働時の対処法は，システムに対する要件に依存する．そこで，ター
1717ゲット依存部のTOPPERS_assert_abortを，システム要件に合致した適切な処理
1718に置き換える必要がある．システム要件によっては，NDEBUGを定義してassert
1719マクロの処理をオブジェクトコード中から消す（「6.2 コンパイルオプション」
1720の節を参照）方法も考えられる．
1721
172211.3 システムログ機能の扱い
1723
1724TOPPERS/ASPカーネルでは，システム開発時の利便性を考慮し，システムログ機
1725能を組み込む設定をデフォルトとしている．
1726
1727それに対して，TOPPERS/ASPカーネルを用いたシステムを機器に組み込む場合は，
1728システムログ機能が意味がない場合も多い．機器への組込みに際してのシステ
1729ムログ機能の設定方法には，以下の方法が考えられる．
1730
1731(1) システムログ機能を用いない
1732
1733システムログ機能を一切使用しない場合には，システムログ機能をシステムに
1734組み込まず（システムコンフィギュレーションファイルでsyslog.cfgをインク
1735ルードしない），システムログ機能のサービスコールを呼び出すソースファイ
1736ルをTOPPERS_OMIT_SYSLOGを定義してコンパイルすればよい．
1737
1738(2) ログ情報の蓄積のみを行う
1739
1740機器に組み込んだ状態で，シリアルポート等を介してシステムを外部と接続す
1741ることができる場合には，システム稼働時にはログ情報の蓄積のみを行い，シ
1742ステムに障害が起きた時などにログ情報を取り出すことで，障害の原因分析の
1743助けとすることができる．
1744
1745具体的な設定方法として，次の2つの方法が考えられる．
1746
1747(2-1) 低レベル出力をメモリに蓄積する
1748
1749必要なログ情報を低レベル出力機能を用いて出力するように設定し，低レベル
1750の文字出力関数（target_fput_log）に送られた文字をメモリ（典型的にはリン
1751グバッファ）に蓄積するようにする．システムの障害時には，そのメモリ領域
1752を読み出す．
1753
1754(2-2) システムログ機能のログバッファに蓄積する
1755
1756必要なログ情報をシステムログ機能のログバッファに記録するように設定する．
1757システムログタスクを動作させないと，ログ情報はログバッファに蓄積されて
1758いく．システムの障害時には，ログバッファの領域を読み出すか，システムロ
1759グタスクを動作させてログ情報を出力させる．
1760
1761(3) 開発時の設定のままとする
1762
1763システムログ機能の設定を，システム開発時のまま変更せず，シリアルポート
1764等にログ情報を垂れ流す方法も考えられる．
1765
176611.4 オブジェクトIDの管理
1767
1768TOPPERS/ASPカーネルでは，オブジェクトのID番号を，コンフィギュレータが割
1769り付ける方法が基本となっている．
1770
1771アプリケーションプログラム中でオブジェクトのID番号を参照する場合には，
1772次の2つの方法が考えられる．
1773
1774(1) オブジェクト識別名を用いる
1775
1776オブジェクト生成のための静的API（CRE_YYY）の第1パラメータに記述したオブ
1777ジェクト識別名を，アプリケーションプログラム中でも用いる方法．
1778
1779コンフィギュレータは，オブジェクト識別名を，割り付けたID番号にマクロ定
1780義するC言語プリプロセッサのディレクティブ（#define）をkernel_cfg.hに生
1781成するため，アプリケーションプログラムからkernel_cfg.hをインクルードす
1782る必要がある．
1783
1784この方法は，オブジェクトコード中にID番号が直接埋め込まれるために実行効
1785率が良い一方で，コンフィギュレータが実行されてkernel_cfg.hが書き換わる
1786度に，アプリケーションプログラムの再コンパイルが必要になるという欠点が
1787ある．そのため，アプリケーションプログラムを構成するファイルの中で，一
1788部のファイルのみでオブジェクト識別名を参照する構成にするといった工夫を
1789することが望ましい．
1790
1791(2) オブジェクトのID番号を保持する変数を用いる
1792
1793オブジェクトのID番号を保持するconst属性を付加した変数を用意し，アプリケー
1794ションプログラム中では，その変数を用いる方法．
1795
1796例えば，TASK1というオブジェクト識別名のタスクに対して，次のような変数を
1797用意する．
1798
1799const ID TASK1_id = TASK1;
1800
1801アプリケーションプログラム中では，この変数（TASK1_id）を用いることで，
1802コンフィギュレータが実行されてkernel_cfg.hが書き換わる度に，上記の変数
1803定義を含んだファイルのみを再コンパイルすればよいことになる．
1804
1805この方法は，アプリケーションプログラムの再コンパイルを最小限にできる利
1806点がある一方で，変数のためのメモリ領域が必要になることに加えて，（プロ
1807セッサによっては）変数アクセスのためのオーバヘッドが生じるという欠点が
1808ある．また，定数ではなく変数であることから，他の変数の初期化には使えな
1809いという制限がある．
1810
1811なお，TOPPERS/ASPカーネルのコンフィギュレータは，--external-idオプショ
1812ンを付加することにより，上記の変数定義をkernel_cfg.c中に生成する機能を
1813持っているので，すべてのオブジェクトIDをこの方法で参照する場合には，こ
1814の機能を用いることを推奨する．
1815
1816コンフィギュレータによるID番号割付けのもう1つの課題として，コンフィギュ
1817レーションファイルの修正により，オブジェクトIDの割付けが変わってしまう
1818ことが挙げられる．これは，アプリケーションソフトウェアの設計仕様書にID
1819番号が記載されている場合や，デバッグ作業においてID番号を直接扱っている
1820場合に，作業効率を低下させる可能性が考えられる．
1821
1822この問題に対応するために，TOPPERS/ASPカーネルのコンフィギュレータに，
1823ID番号の割付け結果をファイルに書き出す機能（--id-output-fileオプション）
1824と，ID番号の割付けをファイルから取り込む機能（--id-input-fileオプション）
1825を用意している．これらの機能を用いて，コンフィギュレータを実行する度に，
1826前回に実行した時にファイルに書き出したID番号の割付けを取り込むことで，
1827前回実行時と同じ割付けを行うことができる．ただし，TOPPERS/ASPカーネルで
1828は，ID番号に抜けがあるのは許されないため，オブジェクトの数が減った場合
1829には（ID番号が大きい方のオブジェクトが減った場合を除いて）エラーとなる．
1830この場合には，ダミーのオブジェクトを生成する方法で回避するしかない．
1831
183211.5 カーネルの内部シンボルのリネーム
1833
1834ASPカーネルでは，モジュール内部の名称が他のモジュール内部の名称と衝突す
1835ることを避けるために，カーネルの内部シンボルは，C言語レベルで，先頭が
1836"_kernel_"または"_KERNEL_"である名称としている．
1837
1838これをソースコードの可読性と両立させるために，ASPカーネルでは，ソースコー
1839ドは自然な名前を用いて記述し，C言語プリプロセッサのマクロ定義（#define）
1840を用いて，それを"_kernel_"または"_KERNEL_"で始まる名前（自然な名前が
1841yyyyyの場合には，_kernel_yyyyy）にリネームする仕組みを用いている．
1842
1843具体的には，関連するディレクトリにxxx_rename.defを置き，そこからリネー
1844ムのためのヘッダファイル（xxx_rename.hおよびxxx_unrename.h）を生成する
1845ツール（utils/genrename）を用意している．
1846
1847この仕組みは，ソースコードの可読性向上に役立つ一方で，弊害もある．例え
1848ば，多くのデバッガで，ソースコード中の名称とオブジェクトコード中の名称
1849が異なるために，ソースコード中の変数名を指定して値を読んだり，関数名を
1850指定してブレークポイントを置くといったことができない．
1851
1852この状況に対応するために，ASPカーネルでは，ソースコード中の該当する名称
1853をリネームするためのユーティリティ（utils/applyrename）を用意している．
1854applyrenameユーティリティに，リネーム定義ファイル（xxx_rename.def）のプ
1855リフィックス（xxxの部分）と，リネームしたいファイルリストを与えると，リ
1856ネーム処理を行なう．例えば，kernelディレクトリのすべてのファイルに対し
1857て，カーネルの内部シンボルをリネームするには，次のコマンドを実行すれば
1858よい．
1859
1860 % cd kernel
1861 % ../utils/applyrename kernel *
1862
1863また，ターゲット依存部のディレクトリのすべてのファイルに対して，カーネ
1864ルの内部シンボルをリネームするには，次のようなコマンドを実行すればよい．
1865
1866 % cd target/dve68k_gcc/
1867 % ../../utils/applyrename target *
1868 % ../../utils/applyrename ../../kernel/kernel *
1869
187011.6 トレースログ記録のサンプルコードの使用方法
1871
1872トレースログ記録のサンプルコードがターゲット依存部に組み込まれている場
1873合には，コンフィギュレーションスクリプトにそれを使用することを指示する
1874オプション（-r）を付加することで，メモリ上にトレースログを記録する機能
1875が有効になる．
1876
1877トレースログ記録の使用方法の一例として，システム起動時にトレースログの
1878記録を開始し，システム終了時に記録したトレースログをダンプするためには，
1879システムコンフィギュレーションファイルに次のような記述を追加する．
1880
1881 #include "logtrace/trace_config.h"
1882 ATT_INI({ TA_NULL, TRACE_AUTOSTOP, trace_initialize });
1883 ATT_TER({ TA_NULL, target_fput_log, trace_dump });
1884
1885ここで，初期化ルーチン（trace_initialize）への引数は，初期化直後のトレー
1886スログの動作モードを指定するものである．指定できる動作モードについては，
1887arch/logtrace/trace_config.h中のコメントに説明がある．
1888
1889終了処理ルーチン（trace_dump）は，記録されたトレースログをターゲット依
1890存の低レベル出力機能（target_fput_log）を利用してダンプするためのもので
1891ある．トレースログを別の方法で取り出す場合には，終了処理ルーチンを登録
1892する必要はない．
1893
1894以上の方法では，trace_initializeを初期化ルーチンで，trace_dumpを終了処
1895理ルーチンで呼び出しているため，初期化ルーチンを呼び出す前や終了処理ルー
1896チンを呼び出した後には，トレースログ記録の機能を利用できない．初期化ルー
1897チンを呼び出す前や終了処理ルーチンを呼び出した後に実行される処理（例え
1898ば，カーネルオブジェクトの初期化処理や，trace_initializeよりも先に登録
1899した初期化ルーチン，trace_dumpよりも先に登録した終了処理ルーチン）でト
1900レースログ記録の機能を利用するためには，trace_initializeとtrace_dumpを
1901適切な場所で呼ぶように修正することが必要である．
1902
190311.7 システムの起動時の初期化処理
1904
1905システムの起動時にアプリケーションで必要となる初期化処理を行うための機
1906能として初期化ルーチンが用意されているが，初期化ルーチンが実行されるよ
1907りも早いタイミングで実行することが必要な初期化処理がある場合がある．
1908
1909このような場合に用いるために，標準的なスタートアップモジュールから，ター
1910ゲットシステム依存の初期化フック（hardware_init_hook）を呼び出すことと
1911している．hardware_init_hookは，カーネルのターゲット依存部で用意されて
1912いるのが標準であるが，これをアプリケーションで用意したものに置き換え，
1913その中でアプリケーションで必要となる初期化処理を行うことができる．
1914
1915ただし，hardware_init_hookの作成する場合には，bssセクションとdataセクショ
1916ンが初期化されていないことや，ライブラリが初期化されていないこと，C言語
1917で記述できるとは限らないことなどに注意が必要である．作成にあたっては，
1918「ターゲット依存部 ポーティングガイド」を参照すること．
1919
1920カーネルのスタートアップモジュールがhardware_init_hookを呼び出すように
1921実装されていない場合には，スタートアップモジュールをアプリケーションで
1922用意したものに置き換える方法を推奨する．
1923
1924
1925１２．参考情報
1926
192712.1 利用条件と利用報告
1928
1929ASPカーネルの利用条件は，各ファイルの先頭に表示されている．著作権は，各
1930ファイルの先頭に表示されている著作権者が保有している．
1931
1932利用条件の(3)の(b)において，利用の形態をTOPPERSプロジェクトに報告する方
1933法としては，ASPカーネルを利用した製品の名称と応用分野，製品化した会社名
1934と業種等の情報を，以下のURLのページから報告するものとする．
1935
1936 http://www.toppers.jp/report.html
1937
1938またその際に，ASPカーネルを使用してのコメントやご意見もいただけると幸い
1939である．
1940
194112.2 保証・適用性・サポート
1942
1943ASPカーネルは無保証で提供されているものである．開発者およびTOPPERSプロ
1944ジェクトは，ASPカーネルに関して，特定の使用目的に対する適合性も含めて，
1945いかなる保証も行わない．また，ASPカーネルの利用により直接的または間接的
1946に生じたいかなる損害に関しても，その責任を負わない．
1947
1948開発者およびTOPPERSプロジェクトは，ASPカーネルに関するサポートの約束は
1949していない．ASPカーネルに関して質問がある場合は，後述のTOPPERSユーザー
1950ズメーリングリストを利用していただけると幸いである．確実なサポートが必
1951要な場合には，有償でサポートサービスを提供している会社に相談されたい．
1952
195312.3 バグレポート
1954
1955ASPカーネルにバグや問題点を発見された場合には，後述のTOPPERSユーザーズ
1956メーリングリストに報告して欲しい．
1957
1958メーリングリストにバグや問題点などを報告する場合には，必要に応じて次の
1959情報を知らせて欲しい．
1960
1961 使用しているカーネルに関する情報
1962 ・ターゲット非依存部のバージョン
1963 ・使用しているターゲット依存部とそのバージョン
1964 ・TOPPERSプロジェクトからのリリースに対する改造箇所（あれば）
1965
1966 ターゲットシステムに関する情報
1967 ・ターゲットプロセッサの種類
1968 ・ターゲットボード等の種類
1969
1970 ホストに関する情報
1971 ・OSのバージョン（サービスパックの適用状況も）
1972 ・コンパイラなどの開発環境のバージョン（Cygwinのバージョンも）
1973
197412.4 ウェブサイト
1975
1976TOPPERSプロジェクトのウェブサイトは，以下のURLにある．
1977
1978 http://www.toppers.jp/
1979
1980TOPPERSプロジェクトやASPカーネルに関する最新情報は，このウェブサイトか
1981ら得ることができる．また，ASPカーネルの最新版は，このウェブサイトからダ
1982ウンロードすることができる．
1983
198412.5 TOPPERSユーザーズメーリングリスト
1985
1986ASPカーネルを含むTOPPERSプロジェクトの開発成果物のユーザに対する情報提
1987供およびユーザ相互間の情報交換を容易にするために，TOPPERSユーザーズメー
1988リングリスト（users@toppers.jp）を用意している．
1989
1990このメーリングリストには，誰でも自由に登録し，メールを送付することがで
1991きる（登録者以外はメールを送付できない）．また，送付されたメールは，誰
1992でも自由にウェブサイトで読むことができる．
1993
1994メーリングリストへの登録方法については，以下のURLのページに説明がある．
1995
1996 http://www.toppers.jp/community.html
1997
199812.6 TOPPERSプロジェクトのメンバ向けのサービス
1999
2000TOPPERSプロジェクトのメンバに対しては，上記に加えて，ASPカーネルに関連
2001して次のサービスを用意している．
2002
2003(1) TOPPERS開発者メーリングリスト
2004
2005TOPPERSプロジェクトのメンバは，ASPカーネルに関する質問，バグや問題点な
2006どの報告に，TOPPERS開発者メーリングリスト（dev@toppers.jp）を利用するこ
2007とができる．
2008
2009(2) ASPカーネルの開発支援サイト
2010
2011ASPカーネルの開発支援のためのTRAC（バグトラッキングシステム）が，以下の
2012URLにある（TRACへのアクセスには，会員パスワードが必要である）．
2013
2014 http://dev.toppers.jp/proj/asp/
2015
2016TOPPERSプロジェクトのメンバは，このサイトから，ウェブインタフェースおよ
2017びsubversionサーバにより，ASPカーネルの開発中のバージョンを得ることがで
2018きる．また，バグトラッキングデータベースにアクセスすることができ，過去
2019のバグ履歴へのアクセスや，バグの登録をすることができる．
2020
202112.7 TOPPERSプロジェクトへの参加
2022
2023TOPPERSプロジェクトでは，何からの形でプロジェクトに貢献していただける方，
2024プロジェクトで開発したソフトウェアをお使いの方，プロジェクトに興味をお
2025持ちの方の参加を求めている．TOPPERSプロジェクトへの参加方法については，
2026以下のページに説明がある．
2027
2028 http://www.toppers.jp/joinus.html
2029
2030
2031１３．リファレンス
2032
203313.1 サービスコール一覧
2034
2035(1) タスク管理機能
2036
2037 ER ercd = act_tsk(ID tskid)
2038 ER ercd = iact_tsk(ID tskid)
2039 ER_UINT actcnt = can_act(ID tskid)
2040 ER ercd = ext_tsk(void)
2041 ER ercd = ter_tsk(ID tskid)
2042 ER ercd = chg_pri(ID tskid, PRI tskpri)
2043 ER ercd = get_pri(ID tskid, PRI *p_tskpri)
2044 ER ercd = get_inf(intptr_t *p_exinf)
2045 ER ercd = ref_tsk(ID tskid, T_RTSK *pk_rtsk)
2046
2047(2) タスク付属同期機能
2048
2049 ER ercd = slp_tsk(void)
2050 ER ercd = tslp_tsk(TMO tmout)
2051 ER ercd = wup_tsk(ID tskid)
2052 ER ercd = iwup_tsk(ID tskid)
2053 ER_UINT wupcnt = can_wup(ID tskid)
2054 ER ercd = rel_wai(ID tskid)
2055 ER ercd = irel_wai(ID tskid)
2056 ER ercd = sus_tsk(ID tskid)
2057 ER ercd = rsm_tsk(ID tskid)
2058 ER ercd = dly_tsk(RELTIM dlytim)
2059
2060(3) タスク例外処理機能
2061
2062 ER ercd = ras_tex(ID tskid, TEXPTN rasptn)
2063 ER ercd = iras_tex(ID tskid, TEXPTN rasptn)
2064 ER ercd = dis_tex(void)
2065 ER ercd = ena_tex(void)
2066 bool_t state = sns_tex(void)
2067 ER ercd = ref_tex(ID tskid, T_RTEX *pk_rtex)
2068
2069(4) 同期・通信機能
2070
2071 ER ercd = sig_sem(ID semid)
2072 ER ercd = isig_sem(ID semid)
2073 ER ercd = wai_sem(ID semid)
2074 ER ercd = pol_sem(ID semid)
2075 ER ercd = twai_sem(ID semid, TMO tmout)
2076 ER ercd = ini_sem(ID semid)
2077 ER ercd = ref_sem(ID semid, T_RSEM *pk_rsem)
2078
2079 ER ercd = set_flg(ID flgid, FLGPTN setptn)
2080 ER ercd = iset_flg(ID flgid, FLGPTN setptn)
2081 ER ercd = clr_flg(ID flgid, FLGPTN clrptn)
2082 ER ercd = wai_flg(ID flgid, FLGPTN waiptn,
2083 MODE wfmode, FLGPTN *p_flgptn)
2084 ER ercd = pol_flg(ID flgid, FLGPTN waiptn,
2085 MODE wfmode, FLGPTN *p_flgptn)
2086 ER ercd = twai_flg(ID flgid, FLGPTN waiptn,
2087 MODE wfmode, FLGPTN *p_flgptn, TMO tmout)
2088 ER ercd = ini_flg(ID flgid)
2089 ER ercd = ref_flg(ID flgid, T_RFLG *pk_rflg)
2090
2091 ER ercd = snd_dtq(ID dtqid, intptr_t data)
2092 ER ercd = psnd_dtq(ID dtqid, intptr_t data)
2093 ER ercd = ipsnd_dtq(ID dtqid, intptr_t data)
2094 ER ercd = tsnd_dtq(ID dtqid, intptr_t data, TMO tmout)
2095 ER ercd = fsnd_dtq(ID dtqid, intptr_t data)
2096 ER ercd = ifsnd_dtq(ID dtqid, intptr_t data)
2097 ER ercd = rcv_dtq(ID dtqid, intptr_t *p_data)
2098 ER ercd = prcv_dtq(ID dtqid, intptr_t *p_data)
2099 ER ercd = trcv_dtq(ID dtqid, intptr_t *p_data, TMO tmout)
2100 ER ercd = ini_dtq(ID dtqid)
2101 ER ercd = ref_dtq(ID dtqid, T_RDTQ *pk_rdtq)
2102
2103 ER ercd = snd_pdq(ID pdqid, intptr_t data, PRI datapri)
2104 ER ercd = psnd_pdq(ID pdqid, intptr_t data, PRI datapri)
2105 ER ercd = ipsnd_pdq(ID pdqid, intptr_t data, PRI datapri)
2106 ER ercd = tsnd_pdq(ID pdqid, intptr_t data, PRI datapri, TMO tmout)
2107 ER ercd = rcv_pdq(ID pdqid, intptr_t *p_data, PRI *p_datapri)
2108 ER ercd = prcv_pdq(ID pdqid, intptr_t *p_data, PRI *p_datapri)
2109 ER ercd = trcv_pdq(ID pdqid, intptr_t *p_data, PRI *p_datapri, TMO tmout)
2110 ER ercd = ini_pdq(ID pdqid)
2111 ER ercd = ref_pdq(ID pdqid, T_RPDQ *pk_rpdq)
2112
2113 ER ercd = snd_mbx(ID mbxid, T_MSG *pk_msg)
2114 ER ercd = rcv_mbx(ID mbxid, T_MSG **ppk_msg)
2115 ER ercd = prcv_mbx(ID mbxid, T_MSG **ppk_msg)
2116 ER ercd = trcv_mbx(ID mbxid, T_MSG **ppk_msg, TMO tmout)
2117 ER ercd = ini_mbx(ID mbxid)
2118 ER ercd = ref_mbx(ID mbxid, T_RMBX *pk_rmbx)
2119
2120(5) メモリプール管理機能
2121
2122 ER ercd = get_mpf(ID mpfid, void **p_blk)
2123 ER ercd = pget_mpf(ID mpfid, void **p_blk)
2124 ER ercd = tget_mpf(ID mpfid, void **p_blk, TMO tmout)
2125 ER ercd = rel_mpf(ID mpfid, void *blk)
2126 ER ercd = ini_mpf(ID mpfid)
2127 ER ercd = ref_mpf(ID mpfid, T_RMPF *pk_rmpf)
2128
2129(6) 時間管理機能
2130
2131 ER ercd = get_tim(SYSTIM *p_systim)
2132 ER ercd = get_utm(SYSUTM *p_sysutm)
2133
2134 ER ercd = sta_cyc(ID cycid)
2135 ER ercd = stp_cyc(ID cycid)
2136 ER ercd = ref_cyc(ID cycid, T_RCYC *pk_rcyc)
2137
2138 ER ercd = sta_alm(ID almid, RELTIM almtim)
2139 ER ercd = ista_alm(ID almid, RELTIM almtim)
2140 ER ercd = stp_alm(ID almid)
2141 ER ercd = istp_alm(ID almid)
2142 ER ercd = ref_alm(ID almid, T_RALM *pk_ralm)
2143
2144(7) システム状態管理機能
2145
2146 ER ercd = rot_rdq(PRI tskpri)
2147 ER ercd = irot_rdq(PRI tskpri)
2148 ER ercd = get_tid(ID *p_tskid)
2149 ER ercd = iget_tid(ID *p_tskid)
2150 ER ercd = loc_cpu(void)
2151 ER ercd = iloc_cpu(void)
2152 ER ercd = unl_cpu(void)
2153 ER ercd = iunl_cpu(void)
2154 ER ercd = dis_dsp(void)
2155 ER ercd = ena_dsp(void)
2156 bool_t state = sns_ctx(void)
2157 bool_t state = sns_loc(void)
2158 bool_t state = sns_dsp(void)
2159 bool_t state = sns_dpn(void)
2160 bool_t state = sns_ker(void)
2161 ER ercd = ext_ker(void)
2162
2163(8) 割込み管理機能
2164
2165 ER ercd = dis_int(INTNO intno)
2166 ER ercd = ena_int(INTNO intno)
2167 ER ercd = chg_ipm(PRI intpri)
2168 ER ercd = get_ipm(PRI *p_intpri)
2169
2170(9) CPU例外管理機能
2171
2172 bool_t stat = xsns_dpn(void *p_excinf)
2173 bool_t stat = xsns_xpn(void *p_excinf)
2174
217513.2 静的API一覧
2176
2177(1) タスク管理機能
2178
2179 CRE_TSK(ID tskid, { ATR tskatr, intptr_t exinf, TASK task,
2180 PRI itskpri, SIZE stksz, STK_T *stk })
2181
2182(3) タスク例外処理機能
2183
2184 DEF_TEX(ID tskid, { ATR texatr, TEXRTN texrtn })
2185
2186(4) 同期・通信機能
2187
2188 CRE_SEM(ID semid, { ATR sematr, uint_t isemcnt, uint_t maxsem })
2189 CRE_FLG(ID flgid, { ATR flgatr, FLGPTN iflgptn })
2190 CRE_DTQ(ID dtqid, { ATR dtqatr, uint_t dtqcnt, void *dtqmb })
2191 CRE_PDQ(ID pdqid, { ATR pdqatr, uint_t pdqcnt, PRI maxdpri, void *pdqmb })
2192 CRE_MBX(ID mbxid, { ATR mbxatr, PRI maxmpri, void *mprihd })
2193
2194(5) メモリプール管理機能
2195
2196 CRE_MPF(ID mpfid, { ATR mpfatr, uint_t blkcnt, uint_t blksz,
2197 MPF_T *mpf, void *mpfmb })
2198
2199(6) 時間管理機能
2200
2201 CRE_CYC(ID cycid, { ATR cycatr, intptr_t exinf, CYCHDR cychdr,
2202 RELTIM cyctim, RELTIM cycphs })
2203 CRE_ALM(ID almid, { ATR almatr, intptr_t exinf, ALMHDR almhdr })
2204
2205(8) 割込み管理機能
2206
2207 ATT_ISR({ ATR isratr, intptr_t exinf, INTNO intno, ISR isr, PRI isrpri })
2208 DEF_INH(INHNO inhno, { ATR inhatr, INTHDR inthdr })
2209 CFG_INT(INTNO intno, { ATR intatr, PRI intpri })
2210
2211(9) CPU例外管理機能
2212
2213 DEF_EXC(EXCNO excno, { ATR excatr, EXCHDR exchdr })
2214
2215(10) システム構成管理機能
2216
2217 DEF_ICS({ SIZE istksz, STK_T *istk })
2218 ATT_INI({ ATR iniatr, intptr_t exinf, INIRTN inirtn })
2219 ATT_TER({ ATR teratr, intptr_t exinf, TERRTN terrtn })
2220
222113.3 バージョン履歴
2222
2223 2006年10月29日 Release 1.A.0 最初のリリース
2224 2007年2月20日 Release 1.A.1
2225 2007年2月20日 Release 1.A.2
2226 2007年7月12日 Release 1.B.0 コンフィギュレータを新バージョンに
2227 2007年7月12日 Release 1.B.1 ライセンス条件の入れ換え
2228 2007年7月16日 Release 1.B.2
2229 2007年7月21日 Release 1.B.3 ディレクトリ構成の変更
2230 2007年8月20日 Release 1.B.4 拡張パッケージの追加
2231 2007年10月16日 Release 1.B.5
2232 2007年11月15日 Release 1.0.0 正式版のリリース
2233 2007年12月23日 Release 1.1.0
2234 2008年3月19日 Release 1.2.0
2235 2008年3月21日 Release 1.2.1
2236 2008年4月12日 Release 1.3.0 一般公開に向けての最終修正
2237 2008年5月13日 Release 1.3.1 最初の一般公開版
2238 2008年8月21日 Release 1.3.2
2239 2009年5月11日 Release 1.4.0
2240 2010年6月28日 Release 1.5.0 拡張パッケージを一般公開
2241 2010年8月1日 Release 1.6.0 cfg-1.6に対応
2242 2011年5月8日 Release 1.7.0 動的生成機能拡張パッケージ等の追加
2243
2244以上
Note: See TracBrowser for help on using the repository browser.