|
51
|
1 \chapter{GearsOSのInterfaceの改良}
|
|
|
2
|
|
16
|
3 \section{GearsOSのInterfaceの構文の改良}
|
|
|
4 GearsOSのInterfaceでは、 従来はDataGearとCodeGearを分離して記述していた。
|
|
|
5 CodeGearの入出力をDataGearとして列挙する必要があった。
|
|
|
6 CodeGearの入出力として\texttt{\_\_code()}の間に記述したDataGearの一覧と、Interface上部で記述したDataGearの集合が一致している必要がある。
|
|
|
7
|
|
|
8 従来の分離している記法の場合、 このDataGearの宣言が一致していないケースが多々発生した。
|
|
|
9 またInterfaceの入力としてのDataGearではなく、 フィールド変数としてDataGearを使うようなプログラミングスタイルを取ってしまうケースも見られた。
|
|
|
10 GearsOSでは、 DataGearやフィールド変数をオブジェクトに格納したい場合、 Interface側ではなくImpl側に変数を保存する必要がある。
|
|
|
11 Interface側に記述してしまう原因は複数考えられる。
|
|
|
12 GearsOSのプログラミングスタイルに慣れていないことも考えられるが、構文によるところも考えられる。
|
|
|
13 CodeGearとDataGearはInterfaceの場合は密接な関係性にあるが、 分離して記述してしまうと「DataGearの集合」と「CodeGearの集合」を別個で捉えてしまう。
|
|
|
14 あくまでInterfaceで定義するCodeGearとDataGearはInterfaceのAPIである。
|
|
|
15 これをユーザーに強く意識させる必要がある。
|
|
|
16
|
|
|
17 golangにもInterfaceの機能が実装されている。
|
|
|
18 golangの場合はInterfaceは関数の宣言部分のみを記述するルールになっている。
|
|
|
19 変数名は含まれていても含まなくても問題ない。
|
|
|
20
|
|
|
21 \begin{lstlisting}[frame=lrbt,label=src:golang_interface,caption={golangのinterface宣言}]
|
|
|
22 type geometry interface {
|
|
|
23 area() float64
|
|
|
24 perim() float64
|
|
|
25 }
|
|
|
26 \end{lstlisting}
|
|
|
27
|
|
37
|
28 \section{Implementの型をいれたことによる間違ったGearsプログラミング}
|
|
|
29 Implementの型を導入したが、 GearsOSのプログラミングをするにつれていくつかの間違ったパターンがあることがわかった。
|
|
|
30 自動生成されるStubCodeGearは、 goto metaから遷移するのが前提であるため、 引数をContextから取り出す必要がある。
|
|
|
31 Contextから取り出す場合は、 実装しているInterfaceに対応している置き場所からデータを取り出す。
|
|
|
32 この置き場所は\texttt{data}配列であり、 配列の添え字は\texttt{enum Data}と対応している。
|
|
|
33 また各CodeGearからgotoする際に、 遷移先のInterfaceに値を書き込みに行く。
|
|
|
34
|
|
|
35
|
|
|
36 Interfaceで定義したCodeGearと対応しているImplementのCodeGearの場合はこのデータの取り出し方で問題はない。
|
|
|
37 しかしImplementのCodeGearから内部でgotoするCodeGearの場合は事情が異なる。
|
|
|
38 内部でgotoするCodeGearは、 Javaなどのプライベートメソッドのように使うことを想定している。
|
|
|
39 このCodeGearのことをprivate CodeGearと呼ぶ。
|
|
|
40 privateCodeGearにgotoする場合、 goto元のCodeGearからは\texttt{goto meta}経由で遷移する。
|
|
|
41 goto metaが発行されるとStub Code Gearに遷移するが、現在のシステムではInterfaceから値をとってくることになってしまう。
|
|
|
42
|
|
48
|
43 \section{context.hの自動生成}
|
|
|
44 GearsOSのContextの定義はcontext.hにある。
|
|
|
45 ContextはGearsOSの計算で使用されるすべてのCodeGear、 DataGearの情報を持っている。
|
|
|
46 context.hではDataGearに対応する\texttt{union Data}型の定義も行っている。
|
|
|
47 Data型はCの共用体であり、 Dataを構成する要素として各DataGearがある。
|
|
|
48 各DataGearは構造体の形で表現されている。
|
|
|
49 各DataGear自体の定義もcontext.hのunion Dataの定義の中で行われている。
|
|
|
50
|
|
|
51 DataGearの定義はInterfaceファイルで行っていた。
|
|
|
52 InterfaceファイルはGearsOS用に拡張されたシンタックスのヘッダファイルを使っており、 直接CbCからロードすることができない。
|
|
|
53 その為従来はプログラマが静的にInterfaceファイルをCbCの文脈に変換し、 context.hに構造体に変換したものを書いていた。
|
|
|
54 この手法では手書きでの構築のために自由度は高かったが、 GearsOSの例題によっては使わないDataGearも、 context.hから削除しない限りcontextに含んでしまう問題があった。
|
|
|
55 さらにInterfaceファイルで定義した型をcontext.hに転記し、それをもとにImplの型を考えてCbCファイルを作製する必要があった。
|
|
|
56 これらをすべてユーザーが行うと、ファイルごとに微妙な差異が発生したりとかなり煩雑な実装を要求されてしまう。
|
|
|
57 DataGearの定義はInterfaceファイルを作製した段階で決まり、 使用しているDataGear、CodeGearはコンパイル時に確定するはずである。
|
|
|
58 使用している各Gearがコンパイル時に確定するならば、 コンパイルの直前に実行されるPerlトランスコンパイラでもGearの確定ができるはずである。
|
|
|
59 ここからcontext.hをコンパイルタイミングでPerlスクリプト経由で生成する手法を考案した。
|
|
|
60
|
|
|
61 \subsection{context.hの作製フロー}
|
|
|
62 GearsCbCからメタ計算を含むCbCファイルに変換するgenerate\_stub.plは各CbCファイルを1つ1つ呼び出していた。
|
|
|
63 context.hを生成しようとする場合、 プロジェクトで利用する全CbCファイルを扱う必要がある。
|
|
|
64
|
|
|
65 Contextの初期化ルーチンを作製するgenerate\_context.plは、その特性上すべてのCbCファイルをロードしていた。
|
|
|
66 したがってcontext.hを作製する場合はこのスクリプトで行うのが良い。
|
|
|
67
|
|
|
68 Perlのモジュールとして\texttt{Gears::Template::Context}を作製した。
|
|
|
69 xv6プロジェクトの場合は一部ヘッダファイルに含める情報が異なる。
|
|
|
70
|
|
|
71 派生モジュールとして\texttt{Gears::Template::Context::XV6}も実装している。
|
|
|
72 これらのテンプレートモジュールはgenerate\_context.plの実行時のオプションで選択可能とした
|
|
16
|
73
|
|
|
74 \section{メタ計算部分の入れ替え}
|
|
|
75 GearsOSでは次のCodeGearに移行する前のMetaCodeGearとして、 デフォルトでは\texttt{\_\_code meta}が使われている。
|
|
20
|
76 \texttt{\_\_code meta}はcontextに含まれているCodeGearの関数ポインタを、 enumからディスパッチして次のStub CodeGearに継続するものである。
|
|
|
77
|
|
|
78 例えばモデル検査をGearsOSで実行する場合、 通常のStub CodeGearのほかに状態の保存などを行う必要がある。
|
|
|
79 この状態の保存に関する一連の処理は明らかにメタ計算であるので、 ノーマルレベルのCodeGearではない箇所で行いたい。
|
|
|
80 ノーマルレベル以外のCodeGearで実行する場合は、 通常のコード生成だとStubCodeGearの中で行うことになる。
|
|
|
81 StubCodeGearは自動生成されてしまうため、 値の取り出し以外のことを行う場合は自分で実装する必要がある。
|
|
|
82 しかしモデル検査に関する処理は様々なCodeGearの後に行う必要があるため、 すべてのCodeGearのStubを静的に実装するのは煩雑である。
|
|
|
83
|
|
22
|
84 ノーマルレベルのCodeGearの処理の後に、StubCodeGear以外のMeta Code Gearを実行したい。
|
|
|
85 Stub Code Gearに直ちに遷移してしまう\texttt{\_\_code meta}以外のMeta CodeGearに、 特定のCodeGearの計算が終わったら遷移したい。
|
|
|
86 このためには、特定のCodeGearの遷移先のMetaCodeGearをユーザーが定義できるAPIが必要となる。
|
|
20
|
87 このAPIを実装すると、ユーザーが柔軟にメタ計算を選択することが可能となる。
|
|
16
|
88
|
|
20
|
89 GearsOSのビルドシステムのAPIとして\texttt{meta.pm}を作製した。
|
|
|
90 これはPerlのモジュールファイルとして実装した。
|
|
23
|
91 meta.pmはPerlで実装されたGearsOSのトランスコンパイラであるgenerate\_stub.plから呼び出される。
|
|
21
|
92 meta.pmの中のサブルーチンである\texttt{replaceMeta}に変更対象のCodeGearと変更先のMetaCodeGearへのgotoを記述する。
|
|
22
|
93 ユーザーはmeta.pmのPerlファイルをAPIとしてGearsOSのトランスコンパイラにアクセスすることが可能となる。
|
|
20
|
94
|
|
21
|
95 具体的な使用例をコード\ref{src:metapm}に示す。
|
|
|
96 meta.pmはサブルーチン\texttt{replaceMeta}が返すリストの中に、特定のパターンで配列を設定する。
|
|
|
97 各配列の0番目には、goto metaを置換したいCodeGearの名前を示すPerl正規表現リテラルを入れる。
|
|
|
98 コード\ref{src:metapm}の例では、\texttt{PhilsImpl}が名前に含まれるCodeGearを指定している。
|
|
|
99 すべてのCodeGearのgotoの先を切り替える場合は\texttt{qr/.*\//}などの正規表現を指定する。
|
|
20
|
100
|
|
|
101 \lstinputlisting[label=src:metapm, caption=meta.pm]{src/meta.pm}
|
|
25
|
102
|
|
|
103 generate\_stub.plはGears CbCファイルの変換時に、 CbCファイルがあるディレクトリにmeta.pmがあるかを確認する。
|
|
|
104 meta.pmがある場合はモジュールロードを行う。
|
|
|
105 meta.pmがない場合はmeta Code Gearにgotoするものをデフォルト設定として使う。
|
|
|
106 各Gode Gearが\texttt{goto文}を呼び出したタイミングでreplaceMetaを呼び出し、 ルールにしたがってgoto文を書き換える。
|
|
37
|
107 変換するCodeGearがルールになかった場合は、 デフォルト設定が呼び出される。
|
|
|
108
|
|
|
109 \section{別Interfaceからの書き出しを取得する必要があるCodeGear}
|
|
|
110
|
|
|
111 従来のMetaCodeGearの生成では、 別のInterfaceからの入力を受け取るCodeGearのStubの生成に問題があった。
|
|
|
112 具体的なこの問題が発生する例題をソースコード\ref{src:insertTest1}に示す。
|
|
43
|
113 \lstinputlisting[label=src:insertTest1, caption=別Interfaceからの書き出しを取得するCodeGearの例]{src/pop2test.cbc}
|
|
37
|
114 この例では\texttt{pop2Test}Code Gearから \texttt{stack->pop2}を呼び出し、 継続として\texttt{pop2Test1}を渡している。
|
|
|
115 \texttt{pop2Test}自体はStackTest Interfaceであり、 \texttt{stack->pop2}の\texttt{stack}はStack Interfaceである。
|
|
43
|
116 例題ではStack Interfaceの実装はSingleLinkedStackである。
|
|
|
117 SingleLinkedStackの\texttt{pop2}の実装をソースコード\ref{src:pop2}に示す。
|
|
|
118 \lstinputlisting[label=src:pop2, caption=SingleLinkedStackのpop2]{src/pop2.cbc}
|
|
44
|
119 pop2はスタックから値を2つ取得するAPIである。
|
|
|
120 pop2の継続は\texttt{next}であり、 継続先に\texttt{data}と\texttt{data1}を渡している。
|
|
|
121 data、 data1は引数で受けている\texttt{union Data*}型の変数であり、 それぞれstackの中の値のポインタを代入している。
|
|
|
122 この操作でstackから値を2つ取得している。
|
|
|
123
|
|
37
|
124
|
|
43
|
125 このコードをgenerate\_stub.pl経由でメタ計算を含むコードに変換する。
|
|
|
126 変換した先のコードを\ref{src:pop2meta}に示す。
|
|
|
127 \lstinputlisting[label=src:pop2meta, caption=SingleLinkedStackのpop2のメタ計算]{src/pop2meta.cbc}
|
|
44
|
128 実際は\texttt{next}は\texttt{goto meta}に変換されてしまう。
|
|
|
129 data、data1は\texttt{goto meta}の前にポインタ変数\texttt{O\_data}が指す値にそれぞれ書き込まれる。
|
|
45
|
130 \texttt{O\_data}はpop2のStub CodeGearである\texttt{pop2SingleLinkedStack\_stub}で作製している。
|
|
44
|
131 つまり\texttt{O\_data}はcontext中に含まれているStack Interfaceのデータ保管場所にある変数dataのアドレスである。
|
|
45
|
132 \texttt{pop2}のAPIを呼び出すと、 Stack Interface中の\texttt{data}にStackに保存されていたデータのアドレスが書き込まれる。
|
|
43
|
133
|
|
37
|
134
|
|
38
|
135 当初Perlスクリプトが生成した\texttt{pop2Test1}のstub CodeGearはソースコード\ref{src:pop2stub-origin}のものである。
|
|
41
|
136 CodeGear間で処理されるデータの流れの概要図を図\ref{fig:stackTest1}に示す。
|
|
38
|
137 \lstinputlisting[label=src:pop2stub-origin, caption=生成されたStub]{src/pop2stub-origin.cbc}
|
|
|
138 \texttt{\_\_code pop2Test}で遷移する先のCodeGearはStackInterfaceであり、 呼び出しているAPIは\texttt{pop2}である。
|
|
45
|
139 pop2で取り出したデータは、 上記で確認した通りContext中のStack Interfaceのデータ格納場所に書き込まれる。
|
|
38
|
140 しかしソースコード\ref{src:pop2stub-origin}の例では\texttt{Gearef(context, StackTest)}でContext中の\texttt{StackTest} Interfaceのdataの置き場所から値を取得している。
|
|
45
|
141 これはInterfaceのImplのCodeGearは、Interfaceから値を取得するというGearsOSのルールの為である。
|
|
|
142 現状ではpop2でせっかく取り出した値をStubCodeGearで取得できない。
|
|
41
|
143
|
|
45
|
144 ここで必要となってくるのは、 実装しているInterface以外の呼び出し元のInterfaceからの値の取得である。
|
|
|
145 今回の例ではStackTest InterfaceではなくStack Interfaceからdata、 data1を取得したい。
|
|
39
|
146 どのInterfaceから呼び出されているかは、 コンパイルタイムには確定できるのでPerlのトランスコンパイラでStub Codeを生成したい。
|
|
|
147
|
|
44
|
148 \begin{figure}[h]
|
|
41
|
149 \begin{center}
|
|
|
150 \includegraphics[width=130mm]{drawio/stackTest1.pdf}
|
|
|
151 \end{center}
|
|
|
152 \caption{stackTest1のstubの概要}
|
|
|
153 \label{fig:stackTest1}
|
|
|
154 \end{figure}
|
|
39
|
155
|
|
|
156 別Interfaceから値を取得するには別の出力があるCodeGearの継続で渡されたCodeGearをまず確定させる。
|
|
|
157 今回の例では\texttt{pop2Test1}が該当する。
|
|
|
158 このCodeGearの入力の値と、 出力があるCodeGearの出力を見比べ、 出力をマッピングすれば良い。
|
|
|
159 Stack Interfaceのpop2はdataとdata1に値を書き込む。
|
|
|
160 pop2Test1の引数はdata, data1, stackであるので、前2つにpop2の出力を代入したい。
|
|
|
161
|
|
|
162 Contextから値を取り出すのはメタ計算であるStub CodeGearで行われる。
|
|
|
163 別Interfaceから値を取り出そうとする場合、 すでにPerlトランスコンパイラが生成しているStubを書き換えてしまう方法も取れる。
|
|
|
164 しかしStubCodeGearそのものを、 別Interfaceから値を取り出すように書き換えてはいけない。
|
|
|
165 これは別Interfaceの継続として渡されるケースと、 次のgoto先として遷移するケースがあるためである。
|
|
|
166 前者のみの場合は書き換えで問題ないが、 後者のケースで書き換えを行ってしまうとStubで値を取り出す先が異なってしまう。
|
|
45
|
167 どのような呼び出し方をしても対応できるようにするには、 Stubを別に別ける必要がある。
|
|
39
|
168
|
|
|
169
|
|
|
170 GearsOSでは継続として渡す場合や、 次のgoto文で遷移する先のCodeGearはノーマルレベルではenumの番号として表現されていた。
|
|
44
|
171 enumが降られるCodeGearは、厳密にはCodeGearそのものではなくStub CodeGearに対して降られる。
|
|
|
172 StubCodeGearを実装した分だけenumの番号が降られるため、 \texttt{goto meta}で遷移する際にenumの番号さえ合わせれば独自定義のStubに継続させることが可能である。
|
|
|
173 別Interfaceから値を取り出したいケースの場合、 取り出してくる先のInterfaceと呼び出し元のCodeGearが確定したタイミングで別のStubCodeGearを生成する。
|
|
|
174 呼び出し元のCodeGearが継続として渡すStubCodeGearのenumを、独自定義したenumに差し替えることでこの問題は解決する。
|
|
|
175 この機能をPerlのトランスコンパイラである\texttt{generate\_stub.pl}に導入した。
|
|
|
176
|
|
45
|
177 \section{別Interfaceからの書き出しを取得するStubの生成}
|
|
|
178 別Interfaceからの書き出しを取得する場合、 generate\_stub.plでは次の点をサポートする機能をいれれば実現可能である。
|
|
|
179
|
|
|
180 \begin{itemize}
|
|
|
181 \item goto先のCodeGearが出力を持つInterfaceでかつ継続で渡しているCodeGearが別Interfaceの場合の検知
|
|
|
182 \begin{itemize}
|
|
|
183 \item この場合はgotoしている箇所で渡している継続のenumを、新たに作製したstubのenumに差し替える
|
|
|
184 \end{itemize}
|
|
|
185 \item 継続で実行された場合に別にInterfaceから値をとってこないといけないCodeGear自身
|
|
|
186 \begin{itemize}
|
|
|
187 \item Stubを別のInterfaceから値をとる実装のものを別に作製する
|
|
|
188 \end{itemize}
|
|
|
189 \end{itemize}
|
|
|
190
|
|
48
|
191
|
|
45
|
192 \texttt{generate\_stub.pl}内では変換対象のCbCのソースコードを2度読み込む。
|
|
|
193 最初の読み込み時に継続の状況を確認し、 2度目の読み込み時に状況を踏まえてコードを生成すれば良い。
|
|
|
194 初回の読み込み時にInterface経由の\texttt{goto}文があった場合に、別Interfaceからの出力があるかなどの情報を確認したい。
|
|
48
|
195
|
|
|
196 \subsection{初回CbCファイル読み込み時の処理}
|
|
|
197
|
|
45
|
198 Interface経由でのgoto文は\texttt{goto interface->method()}の形式で呼び出される。
|
|
|
199 ソースコード\ref{src:parsedOutputStub.pl}はこの形式で来ていた行を読み込んだタイミングで実行される処理である。
|
|
|
200 \lstinputlisting[label=src:parsedOutputStub.pl, caption=goto時に使用するinterfaceの解析]{src/parsedOutputStub.pl}
|
|
|
201
|
|
|
202 1行目の正規表現はInterface経由でのgoto文の正規表現パターンである。
|
|
|
203 変数\texttt{\$instance}はInterfaceのインスタンスである。正規表現パターンでは\texttt{interface->method}の\texttt{->}の前に来ている変数名に紐づけられる。
|
|
|
204 変数\texttt{\$method}はgoto先のInterfaceのAPIである。正規表現パターンでは\texttt{interface->method}の\texttt{->}の後に来ているAPI名である。
|
|
|
205 ソースコード\ref{src:insertTest1}の\texttt{pop2Test}では、 \texttt{stack->pop2}の呼び出しをしているため、 \texttt{stack}がインスタンスであり、 \texttt{pop2}がAPIである。
|
|
|
206 現在解析しているgoto文が含まれているCodeGearの名前は、変数\texttt{\$currentCodeGear}で別途保存している。
|
|
|
207 連想配列である\texttt{\$codeGearInfo}の中には、 各CodeGearで使われている変数と変数の型などの情報が格納されている。
|
|
46
|
208 ソースコード\ref{src:parsedOutputStub.pl}の9行目では、 \texttt{\$codeGearInfo}経由でInterfaceのインスタンスから、具体的にどの型が呼ばれているかを取得する。
|
|
|
209 \texttt{pop2Test}では、 インスタンス\texttt{stack}に対応する型名は\texttt{Stack}と解析される。
|
|
|
210
|
|
|
211 ソースコード\ref{src:parsedOutputStub.pl}の10行目で実行されている\texttt{findExistsOutputDataGear}はgenerate\_stub.pl内の関数である。
|
|
|
212 これはInterfaceの名前とメソッド名を与えると、 Interfaceの定義ファイルのパース結果から出力の有無を確認する動きをする。
|
|
|
213 出力がある場合は出力している変数名の一覧を返す。
|
|
|
214 ソースコード\ref{src:insertTest1}の例では\texttt{pop2}は\texttt{data}と\texttt{data1}を出力している為、 これらがリストとして関数から返される。
|
|
|
215 出力がない場合は偽値を返すために13行目からのif文から先は動かない。
|
|
|
216 出力があった場合はgenerate\_stub.plの内部変数に出力する変数名と、 Interfaceの名前の登録を行う。
|
|
|
217 生成するStubは命名規則が、 \texttt{\_\_code CodeGearStub\_1}のように末尾に\texttt{\_}に続けて数値をいれる。
|
|
|
218 この数値は変換した回数となるため、 この回数の計算を行う。
|
|
|
219
|
|
|
220
|
|
|
221 27行目で\texttt{\$generateHaveOutputStub}のlist要素に現在のCodeGearの名前と、 出力に関する情報を代入している。
|
|
|
222 現在のCodeGearの名前を保存しているのは、この後のコード生成部分でenumの番号を切り替える必要があるためである。
|
|
|
223 ソースコード\ref{src:insertTest1}の例では\texttt{pop2Test}が使うenumを書き換える必要がある為、 ここの\texttt{\$currentCodeGear}はpop2Testとなる。
|
|
|
224 ここで作製した\texttt{\$outputStubElem}は、返還後のCbCコードを生成しているフェーズで呼びされる。
|
|
48
|
225
|
|
|
226 \subsection{enumの差し替え処理}
|
|
|
227
|
|
46
|
228 ソースコード\ref{src:generatePickNext.pl}の箇所は遷移先のenumをPerlスクリプトで生成し、 GearsOSが実行中にenumをcontextに書き込むコードを生成するフェーズである。
|
|
|
229 \lstinputlisting[label=src:generatePickNext.pl, caption=Gearefのコード生成部分]{src/generatePickNext.pl}
|
|
|
230 if文で条件判定をしているが、前者は出力があるケースかどうかのチェックである。
|
|
|
231 続く条件式はGearsOSのビルドルールとして静的に書いたstubの場合は変更を加えない為に、 静的に書いているかどうかの確認をしている。
|
|
|
232 変数\texttt{\$pick\_next}で継続先のCodeGearの名前を作製している。
|
|
52
|
233 CodeGearの名前は一度目の解析で確認した継続先に\texttt{\_}とカウント数をつけている。
|
|
|
234 ここで作製したCodeGearの名前を、3行目でcontextに書き込むCbCコードとして生成している。
|
|
|
235
|
|
|
236
|
|
|
237 実際に生成された例題をソースコード\ref{src:replaceenum}に示す。
|
|
|
238 \lstinputlisting[label=src:replaceenum, caption=enumの番号が差し替えられたCodeGear]{src/replaceenum.cbc} |
